0
Files
src/tools/md_browser
Dirk Pranke 2202afc83d Remove 'dpranke@chromium.org' from OWNERS.
I'm now consistently only using 'dpranke@google.com', so there
shouldn't be any need for the other address.

Change-Id: I7576a8bf318cc9455862ea8ef48960e0e6abf641
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2336508
Reviewed-by: Scott Violet <sky@chromium.org>
Commit-Queue: Dirk Pranke <dpranke@google.com>
Cr-Commit-Position: refs/heads/master@{#794690}
2020-08-04 20:00:26 +00:00
..
2017-03-09 05:36:16 +00:00
2017-03-09 19:46:10 +00:00
2017-03-09 19:46:10 +00:00
2017-04-02 00:29:25 +00:00
2017-04-02 00:29:25 +00:00

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.

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.