peterish8 Google Markdown Style (Quick Reference)
Source: https://google.github.io/styleguide/docguide/style.html
When to load the detailed skill
Read google-markdown-style-detailed when you need:
- Section-by-section rules, examples, or edge cases
- PR review with non-trivial style questions
- Resolving conflicts between local habits and Google style
The detailed skill is linked here so agents can load it automatically alongside this quick reference.
Core rules
- Prefer readable plain Markdown over HTML.
- One H1 per document; use ATX headings (
#). - 80-character line limit for prose; fenced code blocks with language tags.
- Use reference links for long URLs; define references after first use.
- Capitalize product names correctly; sentence case for headings unless title case is established.
- Delete stale docs frequently; small accurate docs beat sprawling outdated ones.
Quick checklist
- Match Google Markdown naming and formatting conventions
- Keep code readable; prefer consistency within the file and package
- Run language-appropriate linters/formatters when available
- Document non-obvious behavior with brief, accurate comments
- Defer to the official guide when this skill is silent