Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 62 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,10 @@ A plain text-based spaced repetition system. Features:
The following Markdown file is a valid hashcards deck:

```
What is the capital of France? / Paris
Q: What is the capital of France?
A: Paris

[Paris] is the capital of [France].
C: [Paris] is the capital of [France].
```

## Building
Expand All @@ -39,18 +40,73 @@ $ hashcards drill $DIRNAME

## Format

A deck is a Markdown file. Blank lines separate flashcards. Question-answer cards use the slash character to separate the sides:
This section describes the text format used by hashcards.

### Basic Cards

Question-answer flashcards are written like this:

```
What is the order of a group? / The cardinality of its underlying set.
Q: What is the order of a group?
A: The cardinality of its underlying set.
```

Cloze cards use square brackets to denote cloze deletions:
Both the question and the answer can span multiple lines:

```
Q: List the PGM minerals.
A:

- ruthenium
- rhodium
- palladium
- osmium
- iridium
- platinum
```

### Cloze Cards

Cloze cards start with the `C:` tag, and use square brackets to denote cloze deletions:

```
The [order] of a group is [the cardinality of its underlying set].
C: The [order] of a group is [the cardinality of its underlying set].
```

Again, cloze cards can span multiple lines:

```
C:
Better is the sight of the eyes than the wandering of the
desire: this is also vanity and vexation of spirit.

— [Ecclesiastes] [6]:[9]
```

### Term-Definition Cards

This is a special shorthand. This:

```
T: lithification
D: The process of turning loose sediment into rock.
```

Is equivalent to writing this:

```
Q: Define: lithification
A: The process of turning loose sediment into rock.

Q: Term for:

The process of turning loose sediment into rock.

A: lithification
```

The constraint here is that the term must be a single line of text.

## Prior Art

- [org-fc](https://github.com/l3kn/org-fc)
Expand Down
6 changes: 5 additions & 1 deletion example/Art.md
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
What is the title of this painting? ![](thetempest.webp) / _The Tempest_
Q: What is the title of this painting?

![](thetempest.webp)

A: _The Tempest_
4 changes: 2 additions & 2 deletions example/French.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
C:
English: [fire]
\
\

French: [feu]
5 changes: 3 additions & 2 deletions example/Geography.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
What is the capital of France? / Paris
Q: What is the capital of France?
A: Paris

[Berlin] is the capital of [Germany].
C: [Berlin] is the capital of [Germany].
3 changes: 2 additions & 1 deletion example/Math.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
What does $\euler$ evaluate to? / $$0$$
Q: What does $\euler$ evaluate to?
A: $0$
Loading