Official Google Markdown formatting standards for consistent documentation.
Quick Reference
Golden Rules
- One sentence per line — easier diffs and reviews
- ATX-style headers — use
#not underlines - Fenced code blocks — use ``` with language
- Reference-style links — for repeated URLs
- Consistent list markers —
-for unordered,1.for ordered - Blank lines around blocks — improve readability
- 80-character line limit — for prose
Headers (Preview)
# Top Level Header
## Second Level
### Third Level
Code Blocks (Preview)
```python
def hello():
print("Hello, world!")
```
Lists (Preview)
- First item
- Second item
- Nested item
- Another nested
1. Ordered first
2. Ordered second
Links (Preview)
[Google](https://google.com)
[Google][google-link]
[google-link]: https://google.com
When to Use This Guide
- Writing documentation
- README files
- Technical writing
- Code reviews
- Onboarding new team members
Install
npx skills add testdino-hq/google-styleguides-skills/markdown
Full Guide
See markdown.md for complete details, examples, and edge cases.