Skip to content

docs: document filters with the bare extension name #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mcanouil merged 1 commit into from
Aug 1, 2026
Merged

docs: document filters with the bare extension name #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## Unreleased

### Documentation

- docs: Document the filter as `filters:` with the bare `code-window` name. The long form `path`/`at` overrides the entry point of every filter the extension contributes, so the documented `at: pre-quarto` pulled the Typst title hotfix from `post-quarto` to `pre-quarto`; the manifest already carries both entry points.

## 1.3.1 (2026-08-01)

### Bug Fixes
Expand Down
6 changes: 2 additions & 4 deletions docs/index.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ Every named code block on this site is drawn by it, including this one:

```{.yaml filename="_quarto.yml"}
filters:
- path: code-window
at: pre-quarto
- code-window
```

## Installation
Expand All @@ -44,8 +43,7 @@ Or install it from your editor with [Quarto Wizard](https://m.canouil.dev/quarto

```yaml
filters:
- path: code-window
at: pre-quarto
- code-window
```

Name the file, and the block is framed with it:
Expand Down
3 changes: 1 addition & 2 deletions docs/reference.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ description: "The complete code-window configuration: the document options, the

```yaml
filters:
- path: code-window
at: pre-quarto
- code-window
```

## Options
Expand Down
3 changes: 1 addition & 2 deletions example.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ author:
orcid: "0000-0002-3396-4549"
url: "https://mickael.canouil.fr"
filters:
- at: pre-quarto
path: code-window
- code-window
syntax-highlighting: github-dark
code-annotations: below
toc: true
Expand Down