chrome-devtools-frontend/docs/styleguide/markdown/markdown.md

Chrome DevTools UI

# Markdown Style Guide in Chromium

## Style Guide

Please write your Markdown file

*   In accordance with [Google Documentation
    Guide](https://google.github.io/styleguide/docguide/style.html)
*   [Limit lines to **80 characters** where
    possible](https://groups.google.com/a/chromium.org/d/msg/chromium-dev/KECdEn562vY/sqRor1frEgAJ)

Unfortunately, `git cl format` will **NOT** do this for you.

## Documentation Guide

New documentation related to code structure should be put in Markdown. The best
practices recommendation is to put a `README.md` file in the code directory
closest to your component or code.

See [Chromium Documentation
Guidelines](https://chromium.googlesource.com/chromium/src/+/HEAD/docs/documentation_guidelines.md)
for details.

[Here are some
examples](https://cs.chromium.org/search?q=file:/devtools-frontend/src/front_end/+-file:/third_party/+file:README.md)
to learn from.

## Making Changes

See [Creating
Documentation](/docs/README.md#creating-documentation).