diff options
| author |  jcgregorio <jcgregorio@google.com> | 2015-01-29 09:55:14 -0800 |
|---|---|---|
| committer |  Commit bot <commit-bot@chromium.org> | 2015-01-29 09:55:14 -0800 |
| commit | 879140da747c40e3a3ca0ad142f9b95726bde0f1 (patch) | |
| tree | 9888f0e9b890dc4e15bc9881f224ef40889ab956 /site/dev/tools | |
| parent | 52ee8139904ad3823cb99f59c45f8da218ba2392 (diff) | |
Add docs for running docserver locally.
BUG=skia:3346
Review URL: https://codereview.chromium.org/891483002
Diffstat (limited to 'site/dev/tools')
| -rw-r--r-- | site/dev/tools/markdown.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/site/dev/tools/markdown.md b/site/dev/tools/markdown.md index c7a7324336..c1230d2a59 100644 --- a/site/dev/tools/markdown.md +++ b/site/dev/tools/markdown.md @@ -13,6 +13,28 @@ with the value of the Reitveld issue id: https://skia.org?cl=REITVELD_ISSUE_NUMBER +You can also run a local copy of the documentation server, which will allow +you to preview changes much quicker. You must have [Go](https://golang.org) +installed on your computer, which you will have if you are running on a Google +corporate workstation. Run: + + go get skia.googlesource.com/buildbot.git/doc/go/docserver + +And then **from within** the directory of your local Git checkout of Skia run: + + docserver --preview + +Then visit http://localhost:8000 to preview your changes. There is no need to +restart the server for file changes, but you will need to restart it if there +are changes to the navigation menu, i.e. you add or remove a file and want it +to appear in the navigation on the right hand side of the page. + +If port 8000 is unavailable on your machine you can set the port to use via +the --port flag: + + docserver --preview --port=:8002 + + Some Example MarkDown --------------------- |