OLD | NEW |
1 # How to use Markdown | 1 # How to use Markdown |
2 | 2 |
3 Markdown is a lightweight markup language which can be easily converted to | 3 Markdown is a lightweight markup language which can be easily converted to |
4 HTML. | 4 HTML. |
5 | 5 |
6 ## Gitiles reference guide | 6 ## Gitiles reference guide |
7 | 7 |
8 For the full reference guide for the version of Markdown used to render Chromium | 8 For the full reference guide for the version of Markdown used to render Chromium |
9 pages, see the [reference for Gitiles Markdown][gtref]. | 9 pages, see the [reference for Gitiles Markdown][gtref]. |
10 | 10 |
| 11 ## Google style guide |
| 12 |
| 13 Be sure to read the |
| 14 [Google style guide for Markdown](https://github.com/google/styleguide/blob/gh-p
ages/docguide/style.md). |
| 15 |
11 ## Local preview of changes | 16 ## Local preview of changes |
12 | 17 |
13 To see how the pages you edit will look, run the following command from your | 18 To see how the pages you edit will look, run the following command from your |
14 Chromium checkout (`src/` directory) to start up a server on | 19 Chromium checkout (`src/` directory) to start up a server on |
15 http://localhost:8080/: | 20 http://localhost:8080/: |
16 | 21 |
17 ```bash | 22 ```bash |
18 python tools/md_browser/md_browser.py | 23 python tools/md_browser/md_browser.py |
19 ``` | 24 ``` |
20 | 25 |
21 You can then navigate to http://localhost:8080/blimp/README.md | 26 You can then navigate to http://localhost:8080/blimp/README.md |
22 in your browser to see the result locally. Just refresh the page after saving | 27 in your browser to see the result locally. Just refresh the page after saving |
23 a `*.md` file to see an updated result. | 28 a `*.md` file to see an updated result. |
24 | 29 |
25 [gtref]: https://gerrit.googlesource.com/gitiles/+/master/Documentation/markdown
.md | 30 [gtref]: https://gerrit.googlesource.com/gitiles/+/master/Documentation/markdown
.md |
OLD | NEW |