Authoring
The content syntax Docyard understands.
Authoring
Docyard pages are plain files in your content directory. Two formats are supported, and both flow through the same pipeline:
- Markdown (
.md) — MDC-flavored Markdown: GitHub-style Markdown plus component blocks (::component…::). - Quarto (
.qmd) — the same Markdown, plus the Quarto/Pandoc syntax documented in this section..qmdfiles are first-class: search, navigation, and tables of contents work identically to.md.
The Quarto syntax extensions work in both file types:
- Quarto files —
.qmdingestion and frontmatter - Citations —
@key, grouped[@a; @b], bibliographies - Callouts —
::: {.callout-note}admonitions - Cross-references — numbered figures,
tables, and equations with
@fig-/@tbl-/@eq-references, plus math
Cross-references resolve across pages: this sentence links to Figure 1, which lives on the cross-references page.
Pages and navigation
- Every
.md/.qmdfile becomes a page; directories become sidebar sections. - Numeric filename prefixes (
1.,2., …) set the order and are stripped from URLs (docs/1.intro.md→/docs/intro). - An
index.mdin a directory is that section's landing page. - Frontmatter
titleanddescriptiondrive navigation, SEO, and search.
Code execution
Docyard renders Quarto syntax natively, without the Quarto binary — so
Python/R/Julia code cells are shown as code blocks but not executed. If you
need live cell output, render those files with quarto render before the
docyard build (e.g. in site.preHook).