commit | 6ea55b03e28d20884a6ab87da08805762fab38a4 | [log] [tgz] |
---|---|---|
author | teravest <teravest@chromium.org> | Wed Mar 15 22:23:59 2017 |
committer | Commit bot <commit-bot@chromium.org> | Wed Mar 15 22:23:59 2017 |
tree | f9127849c8afed2da033ac3c4fa1c9597c62760b | |
parent | 4049359ebe55663d6797038794e0e01be20c5050 [diff] |
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-Original-Commit-Position: refs/heads/master@{#457234} Cr-Mirrored-From: https://chromium.googlesource.com/chromium/src Cr-Mirrored-Commit: 9fc66c2cd53582af4f0ad3f4c6ebf169a16678bf
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.