| OLD | NEW |
| (Empty) |
| 1 # md_browser | |
| 2 | |
| 3 This is a simple tool to render the markdown docs in a chromium checkout | |
| 4 locally. It is written in Python and uses the Python 'markdown' package, | |
| 5 which is checked into src/third_party. | |
| 6 | |
| 7 md_browser attempts to emulate the flavor of Markdown implemented by | |
| 8 [Gitiles](https://gerrit.googlesource.com/gitiles/+/master/Documentation/markdow
n.md). | |
| 9 | |
| 10 Gitiles is the source browser running on https://chromium.googlesource.com, | |
| 11 and can be run locally, but to do so requires a Java install and a Buck | |
| 12 install, which can be slightly annoying to set up on Mac or Windows. | |
| 13 | |
| 14 This is a lighterweight solution, which also allows you to preview uncommitted | |
| 15 changes (i.e., it just serves files out of the filesystem, and is not a | |
| 16 full Git repo browser like Gitiles is). | |
| 17 | |
| 18 To run md_browser: | |
| 19 | |
| 20 1. cd to the top of your chromium checkout | |
| 21 | |
| 22 2. run `python tools/md_browser/md_browser.py` | |
| 23 | |
| 24 3. There is no step three. | |
| 25 | |
| 26 This will run a local web server on port 8080 that points to the top | |
| 27 of the repo. You can specify a different port with the `-p` flag. | |
| OLD | NEW |