summaryrefslogtreecommitdiffstats
path: root/blimp/docs
diff options
context:
space:
mode:
authornyquist <nyquist@chromium.org>2015-10-16 13:58:27 -0700
committerCommit bot <commit-bot@chromium.org>2015-10-16 20:59:29 +0000
commit3dc3eea3a1da08b85872a734bb231c1f2e774f18 (patch)
tree9645b2b0e4543ae1df8b4f9403888e728165f8e5 /blimp/docs
parent926c02f36ca65fb5d81dead958a8ff67df7642de (diff)
downloadchromium_src-3dc3eea3a1da08b85872a734bb231c1f2e774f18.zip
chromium_src-3dc3eea3a1da08b85872a734bb231c1f2e774f18.tar.gz
chromium_src-3dc3eea3a1da08b85872a734bb231c1f2e774f18.tar.bz2
[blimp] Add link to Gitiles Markdown reference.
Markdown is a new concept for many chromium engineers, and as such we want to make it easy for contributors to find out how to use it. This CL adds a new page for learning more about Markdown. The page links to the official documentation for Gitiles Markdown, which is the version used to render Chromium documentation, and also provides instructions for how to get a local preview of changes while adding or updating our current Markdown pages. BUG=None Review URL: https://codereview.chromium.org/1414453002 Cr-Commit-Position: refs/heads/master@{#354588}
Diffstat (limited to 'blimp/docs')
-rw-r--r--blimp/docs/markdown.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/blimp/docs/markdown.md b/blimp/docs/markdown.md
new file mode 100644
index 0000000..36ba019
--- /dev/null
+++ b/blimp/docs/markdown.md
@@ -0,0 +1,25 @@
+# How to use Markdown
+
+Markdown is a lightweight markup language which can be easily converted to
+HTML.
+
+## Gitiles reference guide
+
+For the full reference guide for the version of Markdown used to render Chromium
+pages, see the [reference for Gitiles Markdown][gtref].
+
+## Local preview of changes
+
+To see how the pages you edit will look, run the following command from your
+Chromium checkout (`src/` directory) to start up a server on
+http://localhost:8080/:
+
+```bash
+python tools/md_browser/md_browser.py
+```
+
+You can then navigate to http://localhost:8080/blimp/README.md
+in your browser to see the result locally. Just refresh the page after saving
+a `*.md` file to see an updated result.
+
+[gtref]: https://gerrit.googlesource.com/gitiles/+/master/Documentation/markdown.md