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

Unified Diff: tools/md_browser/README.md

Issue 1356203004: Check in a simple pure-python based Markdown previewer. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@add
Patch Set: fix license file Created 5 years, 2 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 | « tools/md_browser/OWNERS ('k') | tools/md_browser/doc.css » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: tools/md_browser/README.md
diff --git a/tools/md_browser/README.md b/tools/md_browser/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..05d6b9d648d1e589f45d09d81a3738440995fc91
--- /dev/null
+++ b/tools/md_browser/README.md
@@ -0,0 +1,27 @@
+# md_browser
+
+This is a simple tool to render the markdown docs in a chromium checkout
+locally. It is written in Python and uses the Python 'markdown' package,
+which is checked into src/third_party.
+
+md_browser attempts to emulate the flavor of Markdown implemented by
+[Gitiles](https://gerrit.googlesource.com/gitiles/+/master/Documentation/markdown.md).
+
+Gitiles is the source browser running on https://chromium.googlesource.com,
+and can be run locally, but to do so requires a Java install and a Buck
+install, which can be slightly annoying to set up on Mac or Windows.
+
+This is a lighterweight solution, which also allows you to preview uncommitted
+changes (i.e., it just serves files out of the filesystem, and is not a
+full Git repo browser like Gitiles is).
+
+To run md_browser:
+
+1. cd to the top of your chromium checkout
+
+2. run `python tools/md_browser/md_browser.py`
+
+3. There is no step three.
+
+This will run a local web server on port 8080 that points to the top
+of the repo. You can specify a different port with the `-p` flag.
« no previous file with comments | « tools/md_browser/OWNERS ('k') | tools/md_browser/doc.css » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698