0
Files
src/tools/md_browser
Dirk Pranke aefb264aca Change 'dpranke@chromium.org' -> 'dpranke@google.com' in OWNERS files.
I'm switching to using just my @google.com account everywhere.

R=pinkerton@chromium.org

Change-Id: I06ee1b3a7068107f71de4b6072f9ca0585dbd8c5
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2207588
Reviewed-by: Mike Pinkerton <pinkerton@chromium.org>
Commit-Queue: Dirk Pranke <dpranke@chromium.org>
Cr-Commit-Position: refs/heads/master@{#770769}
2020-05-20 21:15:27 +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.