This repository contains comprehensive technical reference materials for Documentation as Code practices, MkDocs formatting guides, and platform development standards within the 40docs ecosystem.
- Documentation as Code - Principles and practices for treating documentation like source code
- Industry Examples - Real-world implementations of Documentation as Code
- Documentation Layout - Content organization and structure guidelines
- FAQ - Frequently asked questions about the platform and practices
- Git Reference - Git workflows and best practices for documentation projects
- Markdown Reference - Comprehensive Markdown syntax guide
The mkdocs/ directory contains detailed formatting references for MkDocs Material theme:
| Guide | Description |
|---|---|
| Index | Overview of MkDocs formatting capabilities |
| Admonitions | Callout boxes, alerts, and note formatting |
| Annotations | Interactive content annotations |
| Buttons | Button styling and formatting |
| Code Blocks | Syntax highlighting and code presentation |
| Content Tabs | Tabbed content organization |
| Data Tables | Table formatting and advanced features |
| Diagrams | Mermaid diagrams and flowcharts |
| External Files | Including external content |
| Formatting | Text formatting and typography |
| Grids | Layout grids and card arrangements |
| Icons & Emojis | Icon libraries and emoji usage |
| Images | Image handling, sizing, and optimization |
| Lists | List formatting and task lists |
| Tooltips | Interactive tooltip implementation |
This reference collection serves multiple audiences:
- Comprehensive formatting guides for creating professional documentation
- Best practices for Documentation as Code workflows
- Style guidelines and consistency standards
- Quick reference for MkDocs Material theme capabilities
- Code examples and implementation patterns
- Integration guidelines for documentation in development workflows
- Self-service guides for common documentation tasks
- Troubleshooting resources and FAQs
- Examples and templates for consistent formatting
Use these materials as a reference while creating documentation:
- Check the relevant MkDocs formatting guide for syntax examples
- Follow the Documentation as Code principles for workflow practices
- Use the FAQ for common questions and solutions
When creating new documentation:
- Start with the appropriate MkDocs formatting guide
- Follow the documentation layout guidelines
- Test formatting using the provided examples
- Reference the Git workflows for collaboration
These references support the broader 40docs platform:
- Content is designed for MkDocs Material theme
- Examples assume standard platform extensions and configurations
- Guidelines align with platform automation and CI/CD processes
- Browse the Index: Start with
index.mdfor an overview of available resources - Explore by Topic: Navigate to specific guides based on your documentation needs
- Test Examples: Use the code examples in your own MkDocs projects
- Follow Practices: Implement Documentation as Code principles in your workflow
This reference collection is actively maintained to:
- Keep pace with MkDocs Material theme updates
- Incorporate new Documentation as Code best practices
- Address common user questions and use cases
- Ensure examples remain current and functional
For questions about these references:
- Check the FAQ for common questions
- Review specific formatting guides for detailed examples
- Consult the Documentation as Code principles for workflow guidance
Part of the 40docs Documentation as Code Ecosystem - Comprehensive reference materials for modern documentation practices.