https://github.com/steve2955/flashmd

A simple flashcard tool for learning notes written in markdown
https://github.com/steve2955/flashmd

Last synced: about 2 months ago
JSON representation

A simple flashcard tool for learning notes written in markdown

• Host: GitHub
• URL: https://github.com/steve2955/flashmd
• Owner: Steve2955
• License: gpl-3.0
• Created: 2020-05-22T08:23:33.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T06:40:29.000Z (about 2 years ago)
• Last Synced: 2024-10-13T16:46:52.269Z (3 months ago)
• Language: Vue
• Homepage: https://steve2955.github.io/flashmd/
• Size: 11 MB
• Stars: 6
• Watchers: 0
• Forks: 1
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        





  

  

  

  
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](https://en.wikipedia.org/wiki/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](https://github.com/Steve2955/flashmd/issues) 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](https://vuejs.org/)

  * [vuex-persistedstate](https://github.com/robinvdvleuten/vuex-persistedstate)

* [markdown-it](https://github.com/markdown-it/markdown-it)

  * [markdown-it-texmath](https://github.com/goessner/markdown-it-texmath)

* [KaTeX](https://katex.org/)

* [Chart.js](https://www.chartjs.org/)

* [highlight.js](https://highlightjs.org/)

* [Bootstrap](https://getbootstrap.com)

## Getting started

First clone this project

```sh

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

cd flashmd

```

Next install all dependencies (you will need [Node.js](https://nodejs.org/) with [NPM](https://www.npmjs.com/) for that)

```sh

npm install

```

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

```sh

npm run serve

npm run build

```

## License

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