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

Unified 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, 11 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 side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: site/dev/tools/markdown.md
diff --git a/site/dev/tools/markdown.md b/site/dev/tools/markdown.md
index c7a73243363631cbecd10a4567eb3a132c26fefc..c1230d2a59add49cbb8023787aaeb22574c42343 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
---------------------
« 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