OLD | NEW |
---|---|
(Empty) | |
1 # md\_browser | |
nodir
2015/09/22 16:38:18
nit: \_ is unnecessary in most of cases. Markdown
Dirk Pranke
2015/09/22 21:16:26
I think Python's markdown does this, but I feel li
nodir
2015/09/22 21:48:56
Proof: https://chrome-internal.googlesource.com/in
| |
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 | |
nodir
2015/09/22 16:38:18
remove blank lines between items
Dirk Pranke
2015/09/22 21:16:27
Acknowledged.
| |
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 |