quarto-dev / quarto-dev/quarto-cli
Better document Language options
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 6k
- Forks
- 458
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 41
Description
In Quarto, some part of a document or project can be tweaked using Language options as documented in https://quarto.org/docs/authoring/language.html
Though in this doc we say:
You can discover all of the language values that can be customized by referencing this file: https://github.com/quarto-dev/quarto-cli/blob/main/src/resources/language/_language.yml.
It would probably be easier user experience to have those option listed in quarto.org in this page, or a specific page.
We could have
- something simple like a table of existing keys, and what they will modify (or their english default)
- Or something more complex with a dynamic content where language can be selected, and default for this language shown for each key.
Anyhow, improving this part could help users IMO.
Related
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the language options page at quarto.org/docs/authoring/language.html and compare it with src/resources/language/_language.yml. Read the related discussion to determine whether the project wants a key/default table or a dynamic presentation. Done means the supported language options are documented on the site with their effect or English default.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100