OLD | NEW |
1 Markdown | 1 Markdown |
2 ======== | 2 ======== |
3 | 3 |
4 This site can handle normal MarkDown and many common extensions. To learn | 4 This site can handle normal MarkDown and many common extensions. To learn |
5 how the following is done please see the [source for this page](./markdown.md). | 5 how the following is done please see the [source for this page](./markdown.md). |
6 Any file you put under `/site/` that has the extension `.md` will be processed | 6 Any file you put under `/site/` that has the extension `.md` will be processed |
7 as MarkDown. All other files will be served directly. For example, images | 7 as MarkDown. All other files will be served directly. For example, images |
8 can be added and they will be served correctly and referenced from within MarkDo
wn files. | 8 can be added and they will be served correctly and referenced from within MarkDo
wn files. |
9 | 9 |
10 When preparing for a code review of site docs you can get a preview of how the | 10 When preparing for a code review of site docs you can get a preview of how the |
11 page will render by visiting the skia.org site and add a query parameter `cl` | 11 page will render by visiting the skia.org site and add a query parameter `cl` |
12 with the value of the Reitveld issue id: | 12 with the value of the Reitveld issue id: |
13 | 13 |
14 https://skia.org?cl=REITVELD_ISSUE_NUMBER | 14 https://skia.org/path/to/markdown-file?cl=REITVELD_ISSUE_NUMBER |
15 | 15 |
16 You can also run a local copy of the documentation server, which will allow | 16 You can also run a local copy of the documentation server, which will allow |
17 you to preview changes much quicker. You must have [Go](https://golang.org) | 17 you to preview changes much quicker. You must have [Go](https://golang.org) |
18 installed on your computer, which you will have if you are running on a Google | 18 installed on your computer, which you will have if you are running on a Google |
19 corporate workstation. Run: | 19 corporate workstation. Run: |
20 | 20 |
21 go get skia.googlesource.com/buildbot.git/doc/go/docserver | 21 go get skia.googlesource.com/buildbot.git/doc/go/docserver |
22 | 22 |
23 And then **from within** the directory of your local Git checkout of Skia run: | 23 And then **from within** the directory of your local Git checkout of Skia run: |
24 | 24 |
(...skipping 367 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
392 | 392 |
393 Output: | 393 Output: |
394 | 394 |
395 <p>If you want your page to validate under XHTML 1.0 Strict, | 395 <p>If you want your page to validate under XHTML 1.0 Strict, |
396 you've got to put paragraph tags in your blockquotes:</p> | 396 you've got to put paragraph tags in your blockquotes:</p> |
397 | 397 |
398 <pre><code><blockquote> | 398 <pre><code><blockquote> |
399 <p>For example.</p> | 399 <p>For example.</p> |
400 </blockquote> | 400 </blockquote> |
401 </code></pre> | 401 </code></pre> |
OLD | NEW |