Skip to content

Commit

Permalink
Closes #10 (wontfix)
Browse files Browse the repository at this point in the history
  • Loading branch information
bonartm authored Jun 23, 2022
1 parent b2d7db2 commit a49a3ff
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

> Markdownish syntax to instantly create simple interactive quiz apps for your static website.
I'm working on this project in my free time to learn more about modern web development and languages. This is a toy project and should not be used in serious projects for now.

### 🚀 Try the [quizdown live editor](https://bonartm.github.io/quizdown-live-editor/)

- supports markdown text formatting, images, syntax highlighting and math rendering.
Expand Down Expand Up @@ -83,9 +85,7 @@ Write questions within a `quizdown` class (edit in the [🚀quizdown editor](htt

## Contributing

Pull requests and feature requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

I'm working on this project to learn more about modern web development and languages. I'm happy for any feedback on how to improve the code base.
Pull requests and feature requests are welcome. For major changes, please open an issue first to discuss what you would like to change. I'm happy for any feedback on how to improve the code base.

After cloning, install the packages with

Expand All @@ -105,6 +105,10 @@ You can also preview a live version with
npm run dev
```

## Wish List

- support for videos via youtube api (#10)

## Credits

Inspired by the [mermaid library](https://mermaid-js.github.io/mermaid/#/) and the python package [quizdown](https://github.com/jjfiv/quizdown).
Inspired by the [mermaid library](https://mermaid-js.github.io/mermaid/#/) and the python package [quizdown](https://github.com/jjfiv/quizdown).

0 comments on commit a49a3ff

Please sign in to comment.