| commit | c2bbfbb423d9ee38901c33fabee7efb5c84362e2 | [log] [tgz] |
|---|---|---|
| author | vapier <vapier@chromium.org> | Sun Apr 02 00:26:16 2017 |
| committer | Commit bot <commit-bot@chromium.org> | Sun Apr 02 00:26:16 2017 |
| tree | a26ad0e748d20c69ca2f3f8b141d25ce7983a0b8 | |
| parent | 6ea55b03e28d20884a6ab87da08805762fab38a4 [diff] |
set tab length to 2 Upstream uses indents of 4 spaces by default [1], but gitiles uses 2 spaces [2]. Change md_browser to match. [1]: https://github.com/waylan/Python-Markdown/issues/451 [2]: https://gerrit.googlesource.com/gitiles/+/master/Documentation/markdown.md#Lists R=dpranke@chromium.org BUG= Review-Url: https://codereview.chromium.org/2772173002 Cr-Original-Commit-Position: refs/heads/master@{#461334} Cr-Mirrored-From: https://chromium.googlesource.com/chromium/src Cr-Mirrored-Commit: a7f56885eb3fa3fa14248c6be1fd26ab94c5c404
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.
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:
cd to the top of your chromium checkout
run python tools/md_browser/md_browser.py
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.