0
Files
src/tools/md_browser
teravest 9fc66c2cd5 Add png and jpg support to md_browser.
This allows md_browser to preview Markdown output that includes
checked-in images.

BUG=None
TESTED=Manually, http://teravest3.bld:8080/user-doc.md

Review-Url: https://codereview.chromium.org/2754663002
Cr-Commit-Position: refs/heads/master@{#457234}
2017-03-15 22:23:59 +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-03-09 19:46:10 +00:00
2017-03-09 19:46:10 +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.