quarto-dev / quarto-dev/quarto-cli

Missing documentation for "categories" in HTML metadata reference

Open
#13,498 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

What would you like to do?

Report an issue on quarto.org

Description

Categories are not mentioned under https://quarto.org/docs/reference/formats/html.html#metadata but are very useful and also available in quarto.

/docs/reference/formats/html.json could include something like this:

{
  "name": "categories",
  "description": "List of categories to classify the document (e.g., for taxonomies, navigation, or filtering). Can be used by themes or output formats to group related content."
},

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

Open /docs/reference/formats/html.json and compare its existing metadata entries with the HTML metadata reference at quarto.org/docs/reference/formats/html.html#metadata. Add the requested categories entry using the issue's description, then verify that categories appears in the HTML metadata reference.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.