blob: c203f4ed8ec8e4c280ec54c64ee33df1747c16ab (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
|
# Chromium docs
This directory contains chromium project documentation in
[Gitiles-flavored Markdown].
It is automatically
[rendered by Gitiles](https://chromium.googlesource.com/chromium/src/+/master/docs/).
## Style guide
Markdown documents must follow the [style guide].
## Previewing changes
You can preview your local changes using [md_browser]:
```bash
# in chromium checkout
./tools/md_browser/md_browser.py
```
To review someone else's changes, apply them locally first:
```bash
# in chromium checkout
git cl patch <CL number or URL>
./tools/md_browser/md_browser.py
```
[Gitiles-flavored Markdown]: https://gerrit.googlesource.com/gitiles/+/master/Documentation/markdown.md
[style guide]: https://github.com/google/styleguide/tree/gh-pages/docguide
[md_browser]: ../tools/md_browser/
|
