Chromium Code Reviews| Index: tools/md_browser/README.md |
| diff --git a/tools/md_browser/README.md b/tools/md_browser/README.md |
| new file mode 100644 |
| index 0000000000000000000000000000000000000000..47def6c1e62ca4c510ecb0bd258be502c8b2ae68 |
| --- /dev/null |
| +++ b/tools/md_browser/README.md |
| @@ -0,0 +1,27 @@ |
| +# 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
|
| + |
| +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](https://gerrit.googlesource.com/gitiles/+/master/Documentation/markdown.md). |
| + |
| +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` |
| + |
|
nodir
2015/09/22 16:38:18
remove blank lines between items
Dirk Pranke
2015/09/22 21:16:27
Acknowledged.
|
| +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. |