Files
react-native-devtools-frontend/docs/styleguide/markdown/markdown.md
T
Benedikt Meurer bf3d9f8403 [docs] Add correct Markdown style guide reference.
Also improve documentation of the Gerrit preview feature.

Bug: 354102605
No-Try: true
Change-Id: I7c886c5ee0636bc714fccd3a4727f99448dd2f76
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/5724788
Auto-Submit: Benedikt Meurer <bmeurer@chromium.org>
Reviewed-by: Yang Guo <yangguo@chromium.org>
Commit-Queue: Yang Guo <yangguo@chromium.org>
2024-07-19 09:24:12 +00:00

1001 B

Markdown Style Guide in Chromium

Style Guide

Please write your Markdown file

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 for details.

Here are some examples to learn from.

Making Changes

See Creating Documentation.