md_browser: Switch to 4-space indent.

The Google Markdown style guide advocates 4-space indent[1].
When configured to use 2-space indent (what we were using
before), md_browser doesn't render 4-space-indented nested
lists or wrapped text correctly. Gitiles (used by Gerrit and
chromium.googlesource.com to render Markdown) also wants
4-space indent rather than 2-space indent.

1. https://github.com/google/styleguide/blob/gh-pages/docguide/style.md#nested-list-spacing

Bug: 736199
Change-Id: Icf4aa298f893672b6a7718aa1dc3e300f6559eff
Reviewed-on: https://chromium-review.googlesource.com/729749
Reviewed-by: Dirk Pranke <dpranke@chromium.org>
Commit-Queue: Dan Erat <derat@chromium.org>
Cr-Original-Commit-Position: refs/heads/master@{#510349}
Cr-Mirrored-From: https://chromium.googlesource.com/chromium/src
Cr-Mirrored-Commit: db0868eb17e4f5a0ca928a14024f6ee8c061c0e8
1 file changed
tree: d2d3cd22f60f9241ccf9cac9baac292b89257eb0
  1. .gitignore
  2. OWNERS
  3. README.md
  4. __init__.py
  5. base.css
  6. doc.css
  7. footer.html
  8. gitiles_autolink.py
  9. gitiles_ext_blocks.py
  10. gitiles_smart_quotes.py
  11. header.html
  12. md_browser.py
  13. prettify.css
  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 python 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.