| commit | 03696428f3fabe392f5e98746eb379fdd64878c6 | [log] [tgz] |
|---|---|---|
| author | Dirk Pranke <dpranke@google.com> | Tue Aug 04 20:00:26 2020 |
| committer | Anthony Polito <apolito@google.com> | Tue Aug 18 20:45:14 2020 |
| tree | eab78fbb7ca31c2d377c15c9024a2c997ca33ed0 | |
| parent | 7e75775447051d4ecb6ab0ca597eda6d809a2963 [diff] |
Copybara Service Migration Initialization. GitOrigin-RevId: 2202afc83dea59463550d2cedbb250f6752e9a9b
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.