https://github.com/ute/qquestion
A quarto extension for quick questions to reader
https://github.com/ute/qquestion
quarto quarto-extension quarto-filter
Last synced: 5 months ago
JSON representation
A quarto extension for quick questions to reader
- Host: GitHub
- URL: https://github.com/ute/qquestion
- Owner: ute
- License: mit
- Created: 2024-02-17T19:28:08.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-25T23:21:11.000Z (about 2 years ago)
- Last Synced: 2024-03-26T00:26:53.068Z (about 2 years ago)
- Topics: quarto, quarto-extension, quarto-filter
- Language: Lua
- Homepage:
- Size: 51.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Qquestion Extension For Quarto
Intersperse text with short questions to the reader. They can include invisible answers or hints that are collected and can be output when format = pdf. Questions are numbered for reference, and marked by a 🤔 emoji. The extension is meant for html and pdf output.
## Installing
```bash
quarto add ute/qquestion
```
This will install the extension under the `_extensions` subdirectory.
If you're using version control, you will want to check in this directory.
## Using
In the yaml, add
```
filters:
- qquestion
```
To insert a question in the text enclose text in `{{?` and `?}}`. To add an answer or hint to the question, separate the answer text from question by `:|:`, within the same pair of brackets.
To collect answers for use in pdf, add the LaTeX command `\collectanswers` before any question with answers. Retrieve answers including a reference number by adding the LaTeX command `\qsolutions` in your text.
Change appearance of questions and answers by hacking the files `qquestions.css` and `qquestions.tex`.
## Example
Here is the source code for a minimal example: [example.qmd](example.qmd).