YuMD is an extension of Markdown allowing for the typesetting of rich and complex notes, with first-class support for flashcard creation directly within your notes. YuMD lets you
- create and sync flaschards between
.yumdnotes and Anki, avoiding the need to write out notes multiple times, - export notes into LaTeX to create well-typeset PDFs, and
- (for advanced users) export notes into HTML files for further processing.
The documentation for YuMD is itself written in YuMD, and can be viewed as a PDF, or as YuMD source code.
The easiest way to install and use YuMD is to download Visual Studio Code and search for the extension YuMD for Visual Studio Code in the marketplace.
To install the VSCode extension the hard way, download and unzip the latest release of YuMD. You only need vscode-extension.zip if you plan to use YuMD with VSCode.
After unzipping, open VSCode, run the command (Ctrl+Shift+P or Command+Shift+P) Extensions: Install from VSIX..., and navigate to yumd.vsix.
Open a .yumd file and begin notetaking!
Please read through the documentation for a primer on how to use YuMD. Reading through the .yumd source of the documentation could be even more informative, by getting familiar with YuMD syntax as you read.