quarto-dev / quarto-dev/quarto-cli

Expose project metadata to Lua filters

Open
#13,029 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement metadata projects
Dominant language
JavaScript
Stars
6k
Forks
458
Avg merge
1d 9h
Merged PRs (30d)
41

Description

It would be useful to be able to access the project metadata (_quarto.yml) in Lua filters and shortcodes:

One use case was to retrieve site-url to modify the links in a multiformat document (PDF/Typst) to make the links target the HTML page rather than local file.
See:

Another use case comes from one of my extension ("GitHub" extension) which could benefits from the repo-url.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how Lua filters and shortcodes receive document metadata, with _quarto.yml as the project-level source. Review the linked discussion and use the site-url and repo-url use cases to define the exposed metadata and verify that both filters and shortcodes can access it.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.