Clone this repo:

Branches

  1. be8cf5a Change 'dpranke@chromium.org' -> 'dpranke@google.com' in OWNERS files. by Dirk Pranke · 2 weeks ago master
  2. dd05cab Update TEAM in OWNERS for build-related directories. by Dirk Pranke · 2 weeks ago
  3. aae45d8 Use normpath to allow for local symlinks by Tim van der Lippe · 2 months ago
  4. 0bfd826 Docs: correctly slugify escaped chars by Nate Fischer · 12 months ago
  5. 2a89b08 Better regex for md_browser.py by Nate Fischer · 1 year ago

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.