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 |
(...skipping 16 matching lines...) Expand all Loading... |
27 Then visit http://localhost:8000 to preview your changes. There is no need to | 27 Then visit http://localhost:8000 to preview your changes. There is no need to |
28 restart the server for file changes, but you will need to restart it if there | 28 restart the server for file changes, but you will need to restart it if there |
29 are changes to the navigation menu, i.e. you add or remove a file and want it | 29 are changes to the navigation menu, i.e. you add or remove a file and want it |
30 to appear in the navigation on the right hand side of the page. | 30 to appear in the navigation on the right hand side of the page. |
31 | 31 |
32 If port 8000 is unavailable on your machine you can set the port to use via | 32 If port 8000 is unavailable on your machine you can set the port to use via |
33 the --port flag: | 33 the --port flag: |
34 | 34 |
35 docserver --preview --port=:8002 | 35 docserver --preview --port=:8002 |
36 | 36 |
| 37 METADATA |
| 38 -------- |
| 39 |
| 40 By default all files and directories that appear in the same level are sorted |
| 41 alphabetically by file name in the navigation menu, with files appearing |
| 42 before directories. You can override this default behavior by adding a |
| 43 METADATA file to a directory. A METADATA file is a JSON file of the following |
| 44 format: |
| 45 |
| 46 ~~~~ |
| 47 { |
| 48 "dirOrder": ["sample", "quick", "special"], |
| 49 "fileOrder": ["download", "api"] |
| 50 } |
| 51 ~~~~ |
| 52 |
| 53 If a file or directory doesn't appear in `dirOrder` or `fileOrder` then it is so
rted |
| 54 to appear after the members of `dirOrder` or `fileOrder` respectively. All |
| 55 files and directories that aren't controlled by a METADATA file are sorted in |
| 56 alphabetical order by their filename. |
37 | 57 |
38 Some Example MarkDown | 58 Some Example MarkDown |
39 --------------------- | 59 --------------------- |
40 | 60 |
41 This is a [link](https://www.google.com). You can also create | 61 This is a [link](https://www.google.com). You can also create |
42 ordered and unordered lists: | 62 ordered and unordered lists: |
43 | 63 |
44 1. First | 64 1. First |
45 2. Second: | 65 2. Second: |
46 * Fee | 66 * Fee |
(...skipping 345 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
392 | 412 |
393 Output: | 413 Output: |
394 | 414 |
395 <p>If you want your page to validate under XHTML 1.0 Strict, | 415 <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> | 416 you've got to put paragraph tags in your blockquotes:</p> |
397 | 417 |
398 <pre><code><blockquote> | 418 <pre><code><blockquote> |
399 <p>For example.</p> | 419 <p>For example.</p> |
400 </blockquote> | 420 </blockquote> |
401 </code></pre> | 421 </code></pre> |
OLD | NEW |