commit | ada1d982a47a25e571606ab1bc654e1292907071 | [log] [tgz] |
---|---|---|
author | dpranke <dpranke@chromium.org> | Tue Nov 08 18:24:50 2016 |
committer | Commit bot <commit-bot@chromium.org> | Tue Nov 08 18:30:23 2016 |
tree | 13916c8f02af2c69a0ce9b168e4aca90d7386e48 | |
parent | dc81eda968d03a413abcfcd62d657f4a19b272b4 [diff] |
Fix abspath references in md_browser. I thought I had fixed this in the patch to support opening files directly in md_browser, but I got my merges confused. R=jsbell@chromium.org Review-Url: https://codereview.chromium.org/2488553002 Cr-Original-Commit-Position: refs/heads/master@{#430658} Cr-Mirrored-From: https://chromium.googlesource.com/chromium/src Cr-Mirrored-Commit: 87f634f6b9b2339cbef11a21a8f40eae2a884487
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.