Mochitto / Markdown2Anki

A CLI tool and an apkg template to allow you to create flashcards from markdown and have a better experience while using anki for your studies. 🌸
105 stars 3 forks source link

Creating a read the docs for the project using pages #4

Open Mochitto opened 1 year ago

Mochitto commented 1 year ago

Right now the Readme is very packed with information and can seem very menacing. It would be much nicer if the project had a doc page with all of the useful information.

Mochitto commented 10 months ago

The github page should be built using either read-the-docs or jekyll. Information on how to setup a jekyll page can be found here.

The idea is transposing the README, CONTRIBUTING and other files to the jekyll website, to make it more accessible. High priority is to be given to accessibility: refer to the a11y project.