Documentation Context
The notes context is used for creating detailed documentation, lecture notes, or papers.
Key Macros
Content Structure
\section{title}
Creates a major section
Args:
title: Section heading
\subsection{title}
Creates a subsection
Args:
title: Subsection heading
\notes{content}
Specifies content that only appears in documentation
Args:
content: Detailed explanatory text
Special Elements
\recommendation{text}
Creates a highlighted recommendation box
Args:
text: Recommendation content
\notesfigure{block}
Includes a figure formatted for documentation
Args:
block: Figure content and caption
Example Usage
\section{Neural Networks}
\notes{
Neural networks are computational models inspired by biological neural systems.
They consist of:
1. Input layers
2. Hidden layers
3. Output layers
}
\recommendation{
Start with simple architectures and gradually increase complexity as needed.
}
\notesfigure{\includediagram{neural-net}{80%}}
Output Formats
HTML documentation
PDF documents
LaTeX papers
Word documents
Notes PDF templates (CIP-0013)
Frontmatter field tex_template selects the pandoc LaTeX template for notespdf:
Value |
Template |
Use |
|---|---|---|
|
|
Lecture notes / long-form |
|
|
Worksheets / assignments |
Convenience: if tex_template is unset and assignment: true, the build uses exercise. Override with tex_template: notes when you need assignment macros but lecture-note chrome.
Exercise PDFs skip forced bibliography / bibtex so citation-free handouts build cleanly.
assignment: True
notespdf: True
tex_template: exercise # optional when assignment is true
Best Practices
Use clear section hierarchy
Include detailed explanations
Add examples and figures
Cross-reference other sections