OLD | NEW |
1 # Chromium docs | 1 # Chromium docs |
2 | 2 |
3 This directory contains chromium project documentation in [Markdown]. | 3 This directory contains chromium project documentation in |
| 4 [Gitiles-flavored Markdown]. |
4 It is automatically | 5 It is automatically |
5 [rendered by Gitiles](https://chromium.googlesource.com/chromium/src/+/master/do
cs/). | 6 [rendered by Gitiles](https://chromium.googlesource.com/chromium/src/+/master/do
cs/). |
6 | 7 |
7 ## Style guide | 8 ## Style guide |
8 | 9 |
9 Markdown documents must follow the [style guide]. | 10 Markdown documents must follow the [style guide]. |
10 | 11 |
11 ## Previewing changes | 12 ## Previewing changes |
12 | 13 |
13 You can preview your local changes using [md_browser]: | 14 You can preview your local changes using [md_browser]: |
14 | 15 |
15 ```bash | 16 ```bash |
16 # in chromium checkout | 17 # in chromium checkout |
17 ./tools/md_browser/md_browser.py | 18 ./tools/md_browser/md_browser.py |
18 ``` | 19 ``` |
19 | 20 |
20 To review someone else's changes, apply them locally first: | 21 To review someone else's changes, apply them locally first: |
21 | 22 |
22 ```bash | 23 ```bash |
23 # in chromium checkout | 24 # in chromium checkout |
24 git cl patch <CL number or URL> | 25 git cl patch <CL number or URL> |
25 ./tools/md_browser/md_browser.py | 26 ./tools/md_browser/md_browser.py |
26 ``` | 27 ``` |
27 | 28 |
28 [Markdown]: https://gerrit.googlesource.com/gitiles/+/master/Documentation/markd
own.md | 29 [Gitiles-flavored Markdown]: https://gerrit.googlesource.com/gitiles/+/master/Do
cumentation/markdown.md |
29 [style guide]: https://github.com/google/styleguide/tree/gh-pages/docguide | 30 [style guide]: https://github.com/google/styleguide/tree/gh-pages/docguide |
30 [md_browser]: ../tools/md_browser/ | 31 [md_browser]: ../tools/md_browser/ |
OLD | NEW |