Skip to content

Releases: bttger/markdown-flashcards

v2.0.0

23 Feb 15:42
a2e853f
Compare
Choose a tag to compare

I'm excited to announce the release of the new version of markdown-flashcards, which includes a new schema and other improvements to enhance your learning experience.

New Card Schema

Markdown-flashcards now uses a new schema, and files with the old v1 schema are no longer supported. However, you can still use them, but any progress made using the old files will not be carried over to the new version. The new schema offers more flexibility with other features and much better readability since the cards are no longer littered with code blocks which contain the metadata.

The metadata now moved to HTML comment tags next to questions. These tags are not visible in the rendered markdown, which make the files much more readable.

It is important to note, that the metadata (box and due date) itself did not change and thus it is possible to simply convert a v1 file to a v2 file. Though, I have not written a script for that yet and you are welcome to write it :)

Card IDs

The introduction of the new schema also introduced IDs for each card. These IDs are maintained throughout a session. By that, mdfc can now precisely update the metadata for a specific card in the file without potentially overwriting concurrent edits made by the user during a learning session.

Lower-level headings

Lower-level headings like ### and #### are now also parsed as questions to allow for better structure in your files.

Easy Sharing of Cards

This release also introduces a new flag, --share-file, which allows for easy sharing of flashcard files with others. It creates a copy of a file with the learning progress being reset.

Flexible File Format

Lastly, the new version allows for more flexibility in the files, as you can now include other content in the file that is not parsed by mdfc. This feature is particularly useful for learners who may want to include additional notes or descriptions under a first-level heading.

I hope these new features and improvements will enhance your learning experience and make it more enjoyable and productive. Let me know what you think of it :)

What's Changed

  • New file schema for new major version by @bttger in #6

Full Changelog: v1.1.0...v2.0.0

v1.1.0

The MVP is done 🎉

19 Dec 12:13
Compare
Choose a tag to compare

I don't have an ARM PC or Apple silicon at home so I could only build for amd64. I'm going to automate the releases in the future via GitHub actions.