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