commit | c2ae091608854973a0b4a31d878ae00cbbda5583 | [log] [tgz] |
---|---|---|
author | Mike Frysinger <vapier@chromium.org> | Fri Jun 15 04:01:35 2018 |
committer | chrome-bot <chrome-bot@chromium.org> | Fri Jun 15 13:14:18 2018 |
tree | 537b3f81081fe1beaab3ea081ca8f4fab91ad074 | |
parent | 002f899ef0bb06969d7ff43d01e06245ac05af6a [diff] |
navbar: add consistent navbar to all md files This provides a consistent header to all rendered markdown files. Change-Id: I03545e4570f9e289d3bbfc51aa9fd4e193958aa9 Reviewed-on: https://chromium-review.googlesource.com/1102046 Commit-Ready: Mike Frysinger <vapier@chromium.org> Tested-by: Mike Frysinger <vapier@chromium.org> Reviewed-by: Dan Erat <derat@chromium.org>
This directory contains public Chromium OS project documentation that is automatically rendered by Gitiles. The docs are written in Gitiles-flavored Markdown.
See the Chromium documentation guidelines and Chromium documentation best practices.
Markdown documents must follow the style guide.
This repository is managed by the repo tool, so you can make changes to it using the same techniques that you'd use for any other repositories in the project. Feel free to bypass the commit queue and commit changes immediately after they are reviewed.
You can also make changes to this repository without using the repo tool. This comes in handy when you don't have a Chromium OS checkout:
git clone https://chromium.googlesource.com/chromiumos/docs curl -Lo .git/hooks/commit-msg https://gerrit-review.googlesource.com/tools/hooks/commit-msg chmod +x .git/hooks/commit-msg cd docs git checkout -b changes (make some changes) git commit -a git push origin HEAD:refs/for/master
The above steps will upload a patch to chromium-review.googlesource.com where you can get your patch reviewed, and submit.
You can preview your local changes using md_browser:
# at top of Chromium OS checkout ./chromium/src/tools/md_browser/md_browser.py -d docs
Then browse to e.g. http://localhost:8080/README.md.
To review someone else's changes, apply them locally first, or just click the gitiles
link near the top of a Gerrit file diff page.