Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lugu/flashdown
Flashcards in Markdown. A spaced repetition program (based on SM-2) for plain text flashcards.
https://github.com/lugu/flashdown
anki flashcards markdown memorization sm-2 spaced-repetition
Last synced: 28 days ago
JSON representation
Flashcards in Markdown. A spaced repetition program (based on SM-2) for plain text flashcards.
- Host: GitHub
- URL: https://github.com/lugu/flashdown
- Owner: lugu
- License: mit
- Created: 2021-01-06T22:09:48.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-21T09:45:02.000Z (2 months ago)
- Last Synced: 2024-11-21T10:31:44.326Z (2 months ago)
- Topics: anki, flashcards, markdown, memorization, sm-2, spaced-repetition
- Language: Go
- Homepage:
- Size: 580 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Essentialist
Programs for [spaced repetition][1] using flashcards in [Markdown][2].
- **Essentialist**: Application for desktops and mobiles
- **Flashdown**: Console application
The space repetition algorithm used is based on [SM-2][3].
Key features:
- **Privacy**: No cloud, your data never leave your device.
- **Easy card creation**: Flash cards are plain text Markdown files.
- **Cross-platform**: Runs on Linux, MacOS, Windows and android.
[1]: https://en.wikipedia.org/wiki/Spaced_repetition
[2]: https://en.wikipedia.org/wiki/Markdown
[3]: https://en.wikipedia.org/wiki/SuperMemo#Description_of_SM-2_algorithm
See the [CONTRIBUTING.md](/.github/CONTRIBUTING.md) for how to report bugs and
submit pull request.
## Flash cards syntax
Each deck of cards is a plain text Markdown files with the extension `.md` (ex:
`sample.md`). You can put all your decks in the same directory.
Each card starts with a heading level 2 (line starting with `##`) defining the
question. The answer is the content following (until the next heading level 2).
You progress is stored in a hidden file `..db` (ex: `.sample.md.db`).
Example of a deck with 3 cards:
```markdown
## Question: what format is used?
Questions and answers are in **Markdown**.
## Are lists supported?
Yes, here is an example:
- one
- **two**
- three
## How to include a table in the answer?
Answer with a table.
| A | B |
| --- | --- |
| 124 | 456 |
```
## Essentialist (GUI)
A GUI version for desktops and mobile (Android, iOS support isn't tested).
### Installation
Download the latest version of Essentialist (available
[here](https://github.com/lugu/flashdown/releases)) or compile it with the
following instructions:
Linux
```shell
go install ./cmd/essentialist
```
MacOS
```shell
CGO_ENABLED=1 go build ./cmd/essentialist
./essentialist
```
Windows
```shell
go build -x -o essentialist.exe ./cmd/essentialist
```
Android
1. Install the Android NDK from .
Set the `ANDROID_NDK_HOME` variable to the directory where the NDK is located.
1. Build the Android APK with:
```shell
cd cmd/essentialist
fyne package -os android
```
1. Plug your phone over USB and install the APK with:
```shell
adb install Essentialist.apk
```
Use the local storage (of your Android device) to import flash cards. For
example, you can put them in an SD card and import them from the Essentialist
application.
## Flashdown (terminal version)
Flashdown is the terminal application.
To install it, clone this repo and run:
```shell
go install ./cmd/flashdown
```
Usage:
```shell
flashdown []
```
Similar project: .