05 formatting rules.md

Format

This section describes the text format used by hashcards.

Basic Cards

Question-answer flashcards are written like this:

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

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:

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]

Hashcards does not support arbitrary Markdown. Files may only contain Q:/A:/C: formatting symbols—no italics, no bold, no headings.

Example

The following Markdown file is a valid hashcards deck:

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

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