File: markdown.md

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (31 lines) | stat: -rw-r--r-- 1,012 bytes parent folder | download | duplicates (9) 
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
 
# Markdown Style Guide in Chromium

## Style Guide

Please write your Markdown file

*   In accordance with [Google Documentation
    Guide](https://google.github.io/styleguide/docguide/style.html)
*   [Limit lines to **80 characters** where
    possible](https://groups.google.com/a/chromium.org/d/msg/chromium-dev/KECdEn562vY/sqRor1frEgAJ)

Unfortunately, `git cl format` will NOT do this for you.

## Documentation Guide

New documentation related to code structure should be put in Markdown. The best
practices recommendation is to put a `README.md` file in the code directory
closest to your component or code.

See [Chromium Documentation
Guidelines](https://chromium.googlesource.com/chromium/src/+/HEAD/docs/documentation_guidelines.md)
for details.

[Here are some
examples](https://cs.chromium.org/search/?q=file:readme.md+-file:/third_party/)
to learn from.

## Making Changes

See [Creating
Documentation](https://chromium.googlesource.com/chromium/src/+/HEAD/docs/README.md#creating-documentation).