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

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

Issue 891483002: Add docs for running docserver locally. (Closed) Base URL: https://skia.googlesource.com/skia.git@master
Patch Set: Created 5 years, 10 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?cl=REITVELD_ISSUE_NUMBER 14 https://skia.org?cl=REITVELD_ISSUE_NUMBER
15 15
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)
18 installed on your computer, which you will have if you are running on a Google
19 corporate workstation. Run:
20
21 go get skia.googlesource.com/buildbot.git/doc/go/docserver
22
23 And then **from within** the directory of your local Git checkout of Skia run:
24
25 docserver --preview
26
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
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.
31
32 If port 8000 is unavailable on your machine you can set the port to use via
33 the --port flag:
34
35 docserver --preview --port=:8002
36
37
16 Some Example MarkDown 38 Some Example MarkDown
17 --------------------- 39 ---------------------
18 40
19 This is a [link](https://www.google.com). You can also create 41 This is a [link](https://www.google.com). You can also create
20 ordered and unordered lists: 42 ordered and unordered lists:
21 43
22 1. First 44 1. First
23 2. Second: 45 2. Second:
24 * Fee 46 * Fee
25 * Fie 47 * Fie
(...skipping 344 matching lines...) Expand 10 before | Expand all | Expand 10 after
370 392
371 Output: 393 Output:
372 394
373 <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,
374 you've got to put paragraph tags in your blockquotes:</p> 396 you've got to put paragraph tags in your blockquotes:</p>
375 397
376 <pre><code>&lt;blockquote&gt; 398 <pre><code>&lt;blockquote&gt;
377 &lt;p&gt;For example.&lt;/p&gt; 399 &lt;p&gt;For example.&lt;/p&gt;
378 &lt;/blockquote&gt; 400 &lt;/blockquote&gt;
379 </code></pre> 401 </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