Practical examples and usage patterns for the template
Quick Reference: Examples | Examples Showcase | Markdown Guide
The usage/ directory contains practical examples, usage patterns, and guides for using specific features of the Research Project Template.
| File | Purpose | Audience |
|---|---|---|
examples.md |
Basic usage examples and patterns | All users |
examples-showcase.md |
Real-world usage examples | Advanced users |
template-description.md |
Template overview and features | New users |
markdown-template-guide.md |
Markdown authoring guide | Content creators |
output-formats.md |
Five-format output matrix (PDF/HTML/Slides/DOCX/EPUB) + render.formats config reference |
All users |
manuscript-numbering-system.md |
Manuscript section numbering | Content creators |
style-guide.md |
Manuscript style guide (equations, figures, captions, tables) | Content creators |
image-management.md |
Image insertion and cross-referencing | Content creators |
visualization-guide.md |
Visualization system guide | Developers |
→ Read Examples - Basic usage patterns
→ Study Examples Showcase - Advanced examples
→ Follow Markdown Template Guide - Authoring guide
→ Use Image Management - Image handling
→ Reference Visualization Guide - Figure generation
../guides/- Skill-level specific guides../reference/common-workflows.md- Step-by-step recipes../core/how-to-use.md- usage guide
../documentation-index.md- documentation index../README.md- Documentation hub overview