For Developers‎ > ‎

Markdown 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.

Use src/tools/md_browser to preview local changes to Markdown files.

Alternatively, there are Chrome extensions such as the the Markdown Viewer extension and Markdown editor app.

Please write your Markdown in accordance with the style guide.

After committing the patch, you can view it at a URL like https://chromium.googlesource.com/chromium/src/+/master/<my path>/README.md (example).

Comments