From 3dc3eea3a1da08b85872a734bb231c1f2e774f18 Mon Sep 17 00:00:00 2001 From: nyquist Date: Fri, 16 Oct 2015 13:58:27 -0700 Subject: [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} --- blimp/README.md | 5 +++++ blimp/docs/markdown.md | 25 +++++++++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 blimp/docs/markdown.md diff --git a/blimp/README.md b/blimp/README.md index e9f4cb2..adff5d3 100644 --- a/blimp/README.md +++ b/blimp/README.md @@ -13,3 +13,8 @@ For testing blimp, read more at [testing](docs/test.md). ## Running Blimp For running blimp, read more at [running](docs/running.md). + +## New to Markdown? + +For learning more about Markdown, read more at [markdown](docs/markdown.md). + 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 -- cgit v1.1