Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bonartm/hugo-quiz
A custom hugo shortcode for interactive quizzes
https://github.com/bonartm/hugo-quiz
hugo-learn-theme hugo-shortcode markdown multiple-choice quiz
Last synced: about 2 months ago
JSON representation
A custom hugo shortcode for interactive quizzes
- Host: GitHub
- URL: https://github.com/bonartm/hugo-quiz
- Owner: bonartm
- License: mit
- Created: 2019-11-19T16:00:26.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-12-25T17:19:04.000Z (over 2 years ago)
- Last Synced: 2024-04-08T02:54:25.331Z (6 months ago)
- Topics: hugo-learn-theme, hugo-shortcode, markdown, multiple-choice, quiz
- Homepage: https://bonartm.github.io/hugo-quiz/
- Size: 3.42 MB
- Stars: 49
- Watchers: 3
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hugo-quiz
> A hugo shortcode for writing quizzes with a markdown-like syntax, called [quizdown](https://github.com/bonartm/quizdown-js).
### 🚀 See the [demo](https://bonartm.github.io/hugo-quiz/) based on the hugo learn theme or try the interactive [quizdown live editor](https://bonartm.github.io/quizdown-live-editor/).
- supports markdown text formatting, images and syntax highlighting.
- different [quiz-types](https://github.com/bonartm/quizdown-js/blob/main/docs/syntax.md): single-choice, multiple-choice, sequence.
- support for hints and explanations.
- [options](https://github.com/bonartm/quizdown-js/blob/main/docs/options.md) for color theme, question shuffling, localization.
- mobile friendly with touch support for all question types.
## Installation
Quizdown is a javascript library which is developed in [a separated project](https://github.com/bonartm/quizdown-js/). hugo-quiz uses a simple shortcode to use quizdown with Hugo. For the library, you can either use a link to a CDN or download and link to the local `quizdown.js` file.
### Hugo-learn theme
1. To install and setup the **library**, copy the file `demo/layouts/partials/custom-header.html` into your local `layouts/partials/` folder. This inserts the nescessary javascript code inside the `head` section of the hugo website.
2. To install the **shortcode**, copy the content from `demo/layouts/shortcodes/quizdown.html` into your local `layouts/shortcodes/` folder.
3. **Currently, the `--minify` flag of the hugo command causes issues with the raw quizdown-markdown code. Please remove the flag when building your website or use the following option in your `config.toml`**:
```toml
[minify]
disableHTML = true
```
### Other themes (without a `custom-header.html`)
If your theme does not offer a `custom-header.html` you need to add the library (and the extensions you want to use) to the `head` section of your website:
```html
...
quizdown.register(quizdownHighlight).register(quizdownKatex).init()
...
```
## Usage (edit example in [🚀 quizdown editor](https://bonartm.github.io/quizdown-live-editor/?code=---%0Aprimary_color%3A%20orange%0Asecondary_color%3A%20lightgray%0Atext_color%3A%20black%0Ashuffle_questions%3A%20false%0A---%0A%0A%23%23%20The%20sound%20of%20dog%0A%0A---%0Ashuffle_answers%3A%20false%0A---%0A%0AWhat%20do%20dogs%20sound%20like%3F%0A%0A%3E%20Some%20hint%0A%0A-%20%5B%20%5D%20yes%0A-%20%5B%20%5D%20no%0A-%20%5B%20%5D%20%60self.sound%20%3D%20%22meow%22%60%0A-%20%5Bx%5D%20wuff%0A%0A%23%23%20Put%20the%20%5Bdays%5D(https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FDay)%20in%20order!%0A%0A%3E%20Monday%20is%20the%20*first*%20day%20of%20the%20week.%0A%0A1.%20Monday%0A2.%20Tuesday%0A3.%20Wednesday%0A4.%20Friday%0A5.%20Saturday%20))
Write quizzes in plain markdown in any of your files in the `content` directory:
```markdown
# Hugo Quiz
{{< quizdown >}}
---
primary_color: orange
secondary_color: lightgray
text_color: black
shuffle_questions: false
---
## The sound of dog
---
shuffle_answers: false
---
What do dogs sound like?
> Some hint
- [ ] yes
- [ ] no
- [ ] `self.sound = "meow"`
- [x] wuff
## Put the [days](https://en.wikipedia.org/wiki/Day) in order!
> Monday is the *first* day of the week.
1. Monday
2. Tuesday
3. Wednesday
4. Friday
5. Saturday
{{< /quizdown >}}
```
## 📚 Documentation
> The quizzes are for fun and not for serious assessment. Since everything is rendered on the client side, the hints and solutions to the questions become visible once javascript is disabled in the browser.
Check out the [documentation](https://github.com/bonartm/quizdown-js/blob/main/docs/) on the main project page. You might be interested in:
- different [quiz-types](https://github.com/bonartm/quizdown-js/blob/main/docs/syntax.md): single-choice, multiple-choice, sequence.
- support for [hints and explanations](https://github.com/bonartm/quizdown-js/blob/main/docs/syntax.md#hints-and-comments).
- [options](https://github.com/bonartm/quizdown-js/blob/main/docs/options.md) for color theme, question shuffling, localization.
## Demo
Tested with version `0.80.0` of Hugo and the Hugo Learn theme.
Visit https://bonartm.github.io/hugo-quiz/ for a live demo based on the [hugo-learn](https://themes.gohugo.io/theme/hugo-theme-learn/en) theme. You can also view a local version of the demo.
First download the theme:
```shell
git submodule update --init --recursive
```
Then start the server:
```shell
cd demo
hugo server -D
```