Skip to content
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.

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

add rendered examples of quarto, weave #43

Merged
merged 1 commit into from
Oct 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ using QuizQuestions
ENV["QQ_LaTeX_dollar_delimiters"] = true

makedocs(sitename="QuizQuestions documentation",
format = Documenter.HTML(ansicolor=true)
format = Documenter.HTML(ansicolor=true),
)
# Documenter can also automatically deploy documentation to gh-pages.
# See "Hosting Documentation" and deploydocs() in the Documenter manual
Expand Down
9 changes: 8 additions & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

[QuizQuestions](https://github.com/jverzani/QuizQuestions.jl) allows the inclusion of self-grading quiz questions within a `Documenter`, `Weave`, [quarto](https://quarto.org), or `Pluto` HTML page.

A few examples:

* [Quarto example](./quarto-example.html)
* [Weave example](./weave-example.html)



## Basics

The basic idea is:
Expand All @@ -24,6 +31,7 @@ radioq(choices, answer; label=question, hint="A hint")

* repeat as desired.

----

The quizzes are written in markdown with the questions in `Julia`
blocks. The above code cells would be enclosed in triple-backtick
Expand All @@ -32,7 +40,6 @@ user. How this is done varies between `Documenter`, `Weave`,
[quarto](https://quarto.org), and `Pluto`. The `examples` directory
shows examples of each.

----

For each question:

Expand Down
Loading
Loading