Rich Content
The body of a details section supports full Markdown.
Code Blocks
Python Example
import great_docs
site = great_docs.build(
package="my-package",
theme="sky",
)
site.serve()Shell Commands
great-docs init my-project
cd my-project
great-docs build
great-docs serveLists
Feature List
Key features of the project:
- Automatic API reference generation
- Dark mode support
- Gradient theme presets
- Version badge system
- Keyboard navigation
Numbered Steps
- Install the package
- Run
great-docs init - Edit
great-docs.yml - Run
great-docs build - Deploy to GitHub Pages
Tables
Comparison Table
| Feature | Free | Pro |
|---|---|---|
| API Reference | Yes | Yes |
| Dark Mode | Yes | Yes |
| Custom Themes | No | Yes |
| Priority Support | No | Yes |
Blockquotes
Notable Quotes
Documentation is a love letter that you write to your future self.
— Damian Conway
Mixed Content
Full Example
Here is a complete example combining multiple elements:
Step 1: Install the package:
pip install great-docsStep 2: Create the configuration:
| Setting | Value |
|---|---|
| theme | “sky” |
| parser | “numpy” |
Step 3: Build and verify:
great-docs build
great-docs serveThe site should be available at
http://localhost:8080.