README.md

FlashMD

A simple flashcard tool for learning notes written in markdown.

View Demo · Report Bug · Request Feature

About The Project

The aim of this project is to make learning easier, by providing you with the right toolset to convert your existing markdown notes without any modification into digital flashcards. While learning you will be able to track your progress and learning efficiency is tried to be improved by spaced repetition.

Currently this is just a small side-project of mine intended for personal use. But nevertheless I would like to encourage everyone to support this project with ideas or code. Feel free to open an issue anytime.

Built With

The core technology this project is build on is Vue.js. Markdown-it is used to handle everything related the markdown parsing/rendering and Bootstrap helps to make this project not look too ugly.

• Vue.js
  • vuex-persistedstate
• markdown-it
  • markdown-it-texmath
• KaTeX
• Chart.js
• highlight.js
• Bootstrap

Getting started

First clone this project

git clone https://github.com/Steve2955/flashmd.git
cd flashmd

Next install all dependencies (you will need Node.js with NPM for that)

npm install

Now you will be able to run a dev-server or build the whole project.

npm run serve
npm run build

License

Distributed under the GNU General Public License v3.0 License. See LICENSE for more information.