-
-
Notifications
You must be signed in to change notification settings - Fork 51
Expand file tree
/
Copy pathgoogle-style.rumdl.toml
More file actions
54 lines (45 loc) · 1.43 KB
/
google-style.rumdl.toml
File metadata and controls
54 lines (45 loc) · 1.43 KB
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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# Google Markdown Style Guide Configuration
# https://google.github.io/styleguide/docguide/style.html
#
# This config enforces Google's Markdown conventions. Use alongside any flavor:
#
# [global]
# flavor = "mkdocs" # Flavor handles parsing, this config handles style
#
[global]
line_length = 80 # Google: "Wrap to 80 characters"
# Headings: ATX-style only (# Heading), not Setext (underlines)
[MD003]
style = "atx"
# Lists: Google uses asterisk (*) for unordered lists
[MD004]
style = "asterisk"
# Lists: 4-space indent for nesting
[MD007]
indent = 4
# Trailing spaces: Google says use backslash for line breaks, not trailing spaces
[MD009]
strict = true
# Lists: Google uses lazy numbering (all 1.) for long lists
# Use "one_or_ordered" to allow both lazy and explicit numbering
[MD029]
style = "one_or_ordered"
# Lists: Google specifies 3 spaces after bullet, 2 after number
# This aligns continuation text with first word
# * List item text
# 1. Numbered item text
[MD030]
ul_single = 3
ul_multi = 3
ol_single = 2
ol_multi = 2
# Code blocks: Fenced (```) preferred over indented
[MD046]
style = "fenced"
# The following rules are enabled by default and match Google's guide:
# - MD018: Space after hash in headings
# - MD022: Blank lines around headings
# - MD025: Single H1 per document
# - MD033: No inline HTML (Google: "Strongly prefer Markdown")
# - MD040: Code blocks should specify language
# - MD047: Files end with single newline