Skip to content

Commit eba83b8

Browse files
Add links to Quarto documentation for extensions, includes, filters, and freeze
1 parent 84c6be9 commit eba83b8

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

posts/2026-03-xx/index.qmd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ This creates a project with two pieces: an `_extension.yml` that declares the en
3939

4040
### `_extension.yml`
4141

42-
The extension metadata lives in `_extensions/{name}/_extension.yml`. For an engine extension, the important part is `contributes.engines`:
42+
The extension metadata lives in [`_extensions/{name}/_extension.yml`](https://quarto.org/docs/extensions/). For an engine extension, the important part is `contributes.engines`:
4343

4444
```yaml
4545
title: My Engine
@@ -137,7 +137,7 @@ interface ExecutionTarget {
137137

138138
Most engines do the same thing here — read the file as a `MappedString` and extract its YAML. `MappedString` is a string that carries source location mapping so that error messages can point back to the right line in the original file. Use `quarto.mappedString.fromFile()` to create one.
139139

140-
`{{< include >}}` shortcodes can appear inside code blocks to import code. Call `context.resolveFullMarkdownForFile()` here to expand them before `execute()` sees the document — see [`EngineProjectContext`](#engineprojectcontext). Both knitr and Jupyter do this.[^2]
140+
[`{{< include >}}` shortcodes](https://quarto.org/docs/authoring/includes.html) can appear inside code blocks to import code. Call `context.resolveFullMarkdownForFile()` here to expand them before `execute()` sees the document — see [`EngineProjectContext`](#engineprojectcontext). Both knitr and Jupyter do this.[^2]
141141

142142
[^2]: Currently, neither marimo nor the Julia engine calls `resolveFullMarkdownForFile`.
143143

@@ -158,7 +158,7 @@ The most important fields of `ExecuteResult`:
158158

159159
- `markdown` — the processed markdown (this is the main output)
160160
- `supporting` — paths to supporting files like figures
161-
- `filters` — pandoc filters to apply
161+
- `filters` [pandoc filters](https://quarto.org/docs/extensions/filters.html) to apply
162162
- `includes` — content to inject into the document header, footer, etc.
163163

164164
Other fields include `metadata`, `pandoc`, `engine`, `engineDependencies`, `preserve`, `postProcess`, and `resourceFiles`.
@@ -288,7 +288,7 @@ This is the top-level interface your engine exports as its default export. It ha
288288
: File extensions this engine supports beyond `.qmd` — for example, Jupyter returns `[".ipynb"]`. Most engine extensions return `[]`.
289289

290290
`canFreeze`
291-
: Whether your engine supports freezing (caching execution results so they aren't re-run).
291+
: Whether your engine supports [freezing](https://quarto.org/docs/projects/code-execution.html#freeze) (caching execution results so they aren't re-run).
292292

293293
`generatesFigures`
294294
: Whether your engine produces figure output.

0 commit comments

Comments
 (0)