commit | 9772d4c05be404c8895b3f659cb99ac813ec58f8 | [log] [tgz] |
---|---|---|
author | John Palmer <jopalmer@chromium.org> | Fri May 21 17:03:43 2021 |
committer | Copybara-Service <copybara-worker@google.com> | Fri May 21 17:14:52 2021 |
tree | 1bbe14a1301b634410951415dddbd8e5d0a22067 | |
parent | 60141af3603925d99bf3fb22fdfca138416339b1 [diff] |
[COIL] Change chromium code search type links to use main rather than master for tools See this doc: go/chromium-coil-change for more info BUG=1210385 Change-Id: I8fdcbf7d7607ac75f4a84d1d697eedede92e6b6d Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2902346 Auto-Submit: John Palmer <jopalmer@chromium.org> Reviewed-by: Dirk Pranke <dpranke@google.com> Reviewed-by: Jesse Doherty <jwd@chromium.org> Commit-Queue: Jesse Doherty <jwd@chromium.org> Cr-Commit-Position: refs/heads/master@{#885533} NOKEYCHECK=True GitOrigin-RevId: ab8812a665a703faf07669b1dc3ed9e6118a41d0
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.