md_browser: Migrate to Python3

With Python-Markdown upgraded to 3.3.4, update the usage and migrate to
Python3. Python3.6+ is supported, and Python2 is no longer supported.

BUG=chromium:1224332
TEST=python3 md_browser.py -d /mnt/host/source/docs/

Change-Id: I61c762e9d7b46b63e8a050fda6858f5032be76b0
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/3301132
Commit-Queue: Yu-Ping Wu <yupingso@chromium.org>
Auto-Submit: Yu-Ping Wu <yupingso@chromium.org>
Reviewed-by: Dirk Pranke <dpranke@google.com>
Cr-Commit-Position: refs/heads/main@{#946862}
NOKEYCHECK=True
GitOrigin-RevId: 4f924c90adb5326cf594701c35838bb8e9f0dc13
5 files changed
tree: c63ac2f506c8a5634e0a88791f055073c09c2b72
  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.