| Benedikt Meurer | bf3d9f8 | 2024-07-19 09:00:25 | [diff] [blame] | 1 | # Markdown Style Guide in Chromium |
| 2 | |
| 3 | ## Style Guide |
| 4 | |
| 5 | Please write your Markdown file |
| 6 | |
| 7 | * In accordance with [Google Documentation |
| 8 | Guide](https://google.github.io/styleguide/docguide/style.html) |
| 9 | * [Limit lines to **80 characters** where |
| 10 | possible](https://groups.google.com/a/chromium.org/d/msg/chromium-dev/KECdEn562vY/sqRor1frEgAJ) |
| 11 | |
| 12 | Unfortunately, `git cl format` will **NOT** do this for you. |
| 13 | |
| 14 | ## Documentation Guide |
| 15 | |
| 16 | New documentation related to code structure should be put in Markdown. The best |
| 17 | practices recommendation is to put a `README.md` file in the code directory |
| 18 | closest to your component or code. |
| 19 | |
| 20 | See [Chromium Documentation |
| 21 | Guidelines](https://chromium.googlesource.com/chromium/src/+/HEAD/docs/documentation_guidelines.md) |
| 22 | for details. |
| 23 | |
| 24 | [Here are some |
| 25 | examples](https://cs.chromium.org/search?q=file:/devtools-frontend/src/front_end/+-file:/third_party/+file:README.md) |
| 26 | to learn from. |
| 27 | |
| 28 | ## Making Changes |
| 29 | |
| 30 | See [Creating |
| 31 | Documentation](/docs/README.md#creating-documentation). |
