Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1)

Side by Side Diff: site/dev/tools/markdown.md

Issue 2118113002: Update markdown docs to specify --local for the local devserver (Closed) Base URL: https://skia.googlesource.com/skia.git@master
Patch Set: Created 4 years, 5 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
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/path/to/markdown-file?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 -u skia.googlesource.com/buildbot.git/doc/go/docserver 21 go get -u 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
25 docserver --preview 25 docserver --preview --local
26 26
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 --local --port=:8002
36 36
37 METADATA 37 METADATA
38 -------- 38 --------
39 39
40 By default all files and directories that appear in the same level are sorted 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 41 alphabetically by file name in the navigation menu, with files appearing
42 before directories. You can override this default behavior by adding a 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 43 METADATA file to a directory. A METADATA file is a JSON file of the following
44 format: 44 format:
45 45
(...skipping 366 matching lines...) Expand 10 before | Expand all | Expand 10 after
412 412
413 Output: 413 Output:
414 414
415 <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,
416 you've got to put paragraph tags in your blockquotes:</p> 416 you've got to put paragraph tags in your blockquotes:</p>
417 417
418 <pre><code>&lt;blockquote&gt; 418 <pre><code>&lt;blockquote&gt;
419 &lt;p&gt;For example.&lt;/p&gt; 419 &lt;p&gt;For example.&lt;/p&gt;
420 &lt;/blockquote&gt; 420 &lt;/blockquote&gt;
421 </code></pre> 421 </code></pre>
OLDNEW
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698