Google Git
Sign in
chromium / chromium / src / tools / md_browser / 3180843cd29f28d458b5dcb3a0575a8f7625b826
commit3180843cd29f28d458b5dcb3a0575a8f7625b826[log] [tgz]
authorPeter Kasting <pkasting@chromium.org>Fri Dec 16 21:07:11 2022
committerCopybara-Service <copybara-worker@google.com>Fri Dec 16 21:21:07 2022
tree9a858dcbd0d148584fc5770e67f6620e369905fe
parentde79b55b74901acef7fe9f9e5832210ebd0ce8b1 [diff]
Update md_browser to work with python-markdown v3.

Perhaps no one has tried to use this tool in a long time? In any case,
it wasn't working for me locally on Windows; this fixes it.

Bug: none
Change-Id: Iee762a62e7c1e4998c3dcc0fd6ca7d20ede664f5
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/4114622
Auto-Submit: Peter Kasting <pkasting@chromium.org>
Reviewed-by: Dirk Pranke <dpranke@google.com>
Commit-Queue: Peter Kasting <pkasting@chromium.org>
Cr-Commit-Position: refs/heads/main@{#1084509}
NOKEYCHECK=True
GitOrigin-RevId: 3f58d92bdcde9e3647a4e2346c995bc4c00a7f0c
3 files changed
tree: 9a858dcbd0d148584fc5770e67f6620e369905fe
  1. .gitignore
  2. __init__.py
  3. base.css
  4. doc.css
  5. footer.html
  6. gitiles_autolink.py
  7. gitiles_ext_blocks.py
  8. gitiles_smart_quotes.py
  9. header.html
  10. md_browser.py
  11. OWNERS
  12. prettify.css
  13. README.md
  14. update-css.sh
README.md

md_browser

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:

  1. cd to the top of your chromium checkout

  2. run python3 tools/md_browser/md_browser.py

  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.