Obsidian Spaced Repetition

https://github.com/st3v3nmw/obsidian-spaced-repetition
Admin
A plugin for Obsidian that helps fight the forgetting curve by reviewing flashcards and notes using...
Tokens:13,950
Snippets:263
Trust Score:9.6
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Local Documentation Viewing Setup

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/contributing.md

Commands for setting up a Python virtual environment and installing dependencies for local documentation viewing.

```bash
python3 -m venv venv
. venv/bin/activate or venv\Scripts\activate if you are on Windows
pip install -r requirements.txt
```

--------------------------------

### Example sw.ts file

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/zh/contributing.md

An example of the Swahili localization file, demonstrating translation.

```typescript
// Swahili

export default {
    EASY: "Rahisi",
    SHOW_ANSWER: "Onyesha Jibu",
    DAYS_STR_IVL: "Siku ${interval}",
    CHECK_ALGORITHM_WIKI:
        'Kwa habari zaidi, angalia <a href="${algoUrl}">utekelezaji wa algorithm</a>.',
};
```

--------------------------------

### Example en.ts file

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/zh/contributing.md

An example of the English localization file.

```typescript
// English

export default {
    EASY: "Easy",
    SHOW_ANSWER: "Show Answer",
    DAYS_STR_IVL: "${interval} days",
    CHECK_ALGORITHM_WIKI:
        'For more information, check the <a href="${algoUrl}">algorithm implementation</a>.',
};
```

--------------------------------

### Question Specific Tags

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/flashcards/decks.md

Example illustrating how a tag at the start of a card's first line applies only to that specific card.

```markdown
#flashcards/deckA
Question1 (in deckA)::Answer1
Question2 (also in deckA)::Answer2
Question3 (also in deckA)::Answer3

#flashcards/deckB Question4 (in deckB)::Answer4

Question6 (in deckA)::Answer6
```

--------------------------------

### RTL Support Example

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/flashcards/flashcards-overview.md

Example of using frontmatter to specify text direction for RTL languages.

```yaml
---
direction: rtl
---
```

--------------------------------

### Serve Local Documentation

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/contributing.md

Command to serve the documentation locally after setup.

```bash
mkdocs serve
```

--------------------------------

### Local documentation viewing: Serve

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/zh/contributing.md

Commands to serve the documentation locally after setup.

```bash
# Activate virtual environment: . venv/bin/activate
# Deploy documentation website: mkdocs serve
```

--------------------------------

### Local documentation viewing: Initialize

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/zh/contributing.md

Commands to set up a virtual environment and install project dependencies for local documentation viewing.

```bash
# Create virtual environment: python3 -m venv venv
# Activate virtual environment: . venv/bin/activate
# Install project dependencies: pip install -r requirements.txt
```

--------------------------------

### Classic Cloze Example

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/flashcards/cloze-cards.md

An example of a classic cloze card with sequence numbers and hints for deletions.

```markdown
This is a ==cloze==^[a hint][^1]. This is ==too, but without hint==[^2]. And this one is asked ==together with the first cloze==[^1].
```

--------------------------------

### Symlinking build files

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/zh/contributing.md

Example bash script for creating symbolic links to build files for development.

```bash
# Remove existing plugin files from Obsidian vault
rm ~/notes/.obsidian/plugins/obsidian-spaced-repetition/main.js ~/notes/.obsidian/plugins/obsidian-spaced-repetition/manifest.json ~/notes/.obsidian/plugins/obsidian-spaced-repetition/styles.css
# Use absolute paths
ln -s /home/stephen/obsidian-spaced-repetition/build/main.js /home/stephen/notes/.obsidian/plugins/obsidian-spaced-repetition
ln -s /home/stephen/obsidian-spaced-repetition/manifest.json /home/stephen/notes/.obsidian/plugins/obsidian-spaced-repetition
ln -s /home/stephen/obsidian-spaced-repetition/styles.css /home/stephen/notes/.obsidian/plugins/obsidian-spaced-repetition
```

--------------------------------

### Custom Cloze Pattern Example

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/flashcards/cloze-cards.md

An example of a custom cloze pattern that emulates Anki-like clozes.

```text
{{[123::]answer[::hint]}}
```

--------------------------------

### Symbolic Link Creation for Development

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/contributing.md

Example commands to create symbolic links between build files and the Obsidian vault for development.

```bash
# remove existing files in the Obsidian vault
rm ~/notes/.obsidian/plugins/obsidian-spaced-repetition/main.js ~/notes/.obsidian/plugins/obsidian-spaced-repetition/manifest.json ~/notes/.obsidian/plugins/obsidian-spaced-repetition/styles.css
# use absolute paths
ln -s /home/stephen/obsidian-spaced-repetition/build/main.js /home/stephen/notes/.obsidian/plugins/obsidian-spaced-repetition
ln -s /home/stephen/obsidian-spaced-repetition/manifest.json /home/stephen/notes/.obsidian/plugins/obsidian-spaced-repetition
ln -s /home/stephen/obsidian-spaced-repetition/styles.css /home/stephen/notes/.obsidian/plugins/obsidian-spaced-repetition
```

--------------------------------

### Simplified Cloze with Hint Example

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/flashcards/cloze-cards.md

An example of a simplified cloze card with a hint provided for one of the deletions.

```markdown
This ==note== doesn't need to have ==number==^[hint] on clozes
```

--------------------------------

### Create a new release branch

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/contributing.md

Example of creating a new branch for a specific release version.

```bash
git switch -c release-v1.9.2
```

--------------------------------

### Swahili Language File Example

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/wiki/Help-Translate

An example of a Swahili language file (`sw.ts`) demonstrating how to translate the strings from the English file.

```typescript
// Swahili

export default {
    EASY: "Rahisi",
    SHOW_ANSWER: "Onyesha Jibu",
    DAYS_STR_IVL: "Siku ${interval}",
    CHECK_ALGORITHM_WIKI: 'Kwa habari zaidi, angalia <a href="${algo_url}">utekelezaji wa algorithm</a>.',
}
```

--------------------------------

### English Language File Example

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/wiki/Help-Translate

An example of the English language file (`en.ts`) showing the structure and keys for translatable strings.

```typescript
// English

export default {
    EASY: "Easy",
    SHOW_ANSWER: "Show Answer",
    DAYS_STR_IVL: "${interval} days",
    CHECK_ALGORITHM_WIKI: 'For more information, check the <a href="${algo_url}">algorithm implementation</a>.',
}
```

--------------------------------

### Swahili Locale File Example

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/contributing.md

Equivalent 'sw.ts' file showing how to inherit from English and override translations for Swahili.

```typescript
// Swahili

const sw: IBaseLocale = {
    ...en, // inherit translations from English, if any are missing
    // Override english translations here
    EASY: "Rahisi",
    SHOW_ANSWER: "Onyesha Jibu",
    DAYS_STR_IVL: "Siku ${interval}",
    CHECK_ALGORITHM_WIKI:
        'Kwa habari zaidi, angalia <a href="${algoUrl}">utekelezaji wa algorithm</a>.',
};

export default sw;
```

--------------------------------

### English Locale File Example

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/contributing.md

Sample 'en.ts' file showing the structure for English translations.

```typescript
// English

const en: IBaseLocale = {
    EASY: "Easy",
    SHOW_ANSWER: "Show Answer",
    DAYS_STR_IVL: "${interval} days",
    CHECK_ALGORITHM_WIKI:
        'For more information, check the <a href="${algoUrl}">algorithm implementation</a>.',
};

export default en;
```

--------------------------------

### Multiple Tags Within a Single File

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/flashcards/decks.md

Example demonstrating how a single file can contain cards for multiple decks using different tags.

```markdown
#flashcards/deckA
Question1 (in deckA)::Answer1
Question2 (also in deckA)::Answer2
Question3 (also in deckA)::Answer3

#flashcards/deckB
Question4 (in deckB)::Answer4
Question5 (also in deckB)::Answer5

#flashcards/deckC
Question6 (in deckC)::Answer6
```

--------------------------------

### Markdown Example for Context

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/wiki/Reviewing-Flashcards

Example of a markdown note structure demonstrating how headings contribute to the flashcard context/title.

```markdown
#flashcards

# Trivia

## Capitals

### Africa

Kenya::Nairobi

### North America

Canada::Ottawa
```

--------------------------------

### Ignoring Cards Example

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/wiki/Reviewing-Flashcards

Example of how to wrap flashcards in HTML comments to prevent them from appearing in review queues.

```html
<!--Card text <!--SR:2021-08-20,13,290--> -->
```

--------------------------------

### Single Cloze Deletion Example

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/flashcards/cloze-cards.md

An example of a simple cloze card with a single deletion, using '==' as the delimiter.

```markdown
The first female prime minister of Australia was ==Julia Gillard==
```

--------------------------------

### Generalized Cloze Overlapping Example

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/flashcards/cloze-cards.md

An example demonstrating generalized cloze overlapping with 'a' (ask), 'h' (hide), and 's' (show) actions.

```markdown
==Some context for items 2 and 4, but that could spoil items 1 and 3. Note that this doesn't even need to be asked==[^hshs]
.
- ==Item 1==[^ashh]
- ==Item 2==[^hash]
- ==Item 3==[^hhas]
- ==Item 4==[^hhha]
```

--------------------------------

### Multiple Cloze Deletions Example

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/flashcards/cloze-cards.md

An example of a cloze card with multiple deletions, which will generate multiple sibling cards.

```markdown
The first female ==prime minister== of Australia was ==Julia Gillard==
```

--------------------------------

### Multi-line style

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/README.md

Example of a multi-line flashcard format.

```markdown
Question
?
Answer
```

--------------------------------

### Single-line style

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/README.md

Example of a single-line flashcard format.

```markdown
Question::Answer
```

--------------------------------

### Card Scheduling Comment Example

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/data-storage.md

Example of how scheduling information is stored in an HTML comment after a card's text.

```html
<!--SR:!2024-08-16,51,230-->
```

--------------------------------

### A Single Card Within Multiple Decks

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/flashcards/decks.md

Example showing how a single card can be tagged as part of multiple decks.

```markdown
#flashcards/language/words #flashcards/trivia #flashcards/learned-from-tv
A group of cats is called a::clowder
```

--------------------------------

### Multi-line reversed style

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/README.md

Example of a multi-line reversed flashcard format.

```markdown
Question
??
Answer
```

--------------------------------

### Using Custom Cloze Patterns in Notes

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/flashcards/cloze-cards.md

Examples of using both highlighted and Anki-like custom cloze patterns within notes.

```markdown
This note has both ==highlighted clozes==[^1] and {{2::anki like clozes}}

And this note has both ==highlighted clozes==^[footnote hint][^1] and {{2::anki like clozes::anki like hint}}
```

--------------------------------

### Single-line reversed style

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/README.md

Example of a single-line reversed flashcard format.

```markdown
Question:::Answer
```

--------------------------------

### Cloze cards

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/README.md

Examples of cloze deletion formats for flashcards.

```markdown
==highlight== your cloze deletions!
```

```markdown
**bolded text**
```

```markdown
{{text in curly braces}}
```

--------------------------------

### Flashcard with multiple parts and scheduling info

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/tests/vaults/notes6/A.md

An example of a flashcard question with multiple parts and scheduling information embedded as a comment.

```markdown
A {{question}} with multiple parts {{Navevo part}} <!--SR:!2024-05-22,1,230!2024-05-25,4,270!2033-03-03,3,333-->
```

--------------------------------

### Note Scheduling Information in YAML Frontmatter

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/data-storage.md

Example of scheduling information stored at the beginning of a note in YAML format within the frontmatter section.

```yaml
---
sr-due: 2024-07-01
sr-interval: 3
sr-ease: 269
---
```

--------------------------------

### Scheduling Information Comment

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/wiki/Reviewing-Flashcards

Example of the HTML comment added after a card is reviewed, containing next review day, interval, and ease.

```html
<!--SR:!2021-08-20,13,290-->
```

--------------------------------

### Running Unit Tests

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/contributing.md

Command to run unit tests for the project.

```bash
pnpm test
```

--------------------------------

### Create and push git tag

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/contributing.md

Creating and pushing a git tag for the new version.

```bash
git tag -a 1.9.2 -m "1.9.2"
git push --tags
```

--------------------------------

### SM-2-OSR Algorithm Details

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/algorithms.md

This code snippet provides the mathematical formulas and logic for the SM-2-OSR algorithm, including initial ease calculation, ease adjustments based on review outcomes (easy, good, hard), interval calculations, and the application of fuzz.

```typescript
if link_count > 0: initial_ease = (1 - link_contribution) * base_ease + link_contribution * average_ease
link_contribution = max_link_factor * min(1.0, log(link_count + 0.5) / log(64)) (cater for uncertainty)

// If the user reviews a concept/note as:
// easy, the ease increases by 20 and the interval changes to old_interval * new_ease / 100 * 1.3 (the 1.3 is the easy bonus)
// good, the ease remains unchanged and the interval changes to old_interval * old_ease / 100
// hard, the ease decreases by 20 and the interval changes to old_interval * 0.5
// The 0.5 can be modified in settings
// minimum ease = 130

// For 8 or more days:
// interval += random_choice({-fuzz, 0, +fuzz})
// where fuzz = ceil(0.05 * interval)
```

--------------------------------

### Switch to main and pull changes

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/contributing.md

Switching back to the main branch and pulling the latest changes.

```bash
git switch main && git pull
```

--------------------------------

### Development Build Command

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/contributing.md

Command to watch for changes and automatically rebuild the plugin during development.

```bash
pnpm dev
```

--------------------------------

### Running Linter

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/contributing.md

Command to run the linter to check for code style issues.

```bash
pnpm lint
```

--------------------------------

### Emulate Mobile View

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/contributing.md

Commands to toggle mobile view emulation in the Obsidian developer console.

```javascript
this.app.emulateMobile(false); // to switch to desktop view

this.app.emulateMobile(true); // to switch to mobile view

this.app.emulateMobile(!this.app.isMobile); // to toggle between desktop and mobile view
```

--------------------------------

### Initial Ease Calculation

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/wiki/Spaced-Repetition-Algorithm

Calculates the initial ease of a concept based on linked notes and their average ease, considering note importance and a base ease.

```plaintext
if link_count > 0: initial_ease = (1 - link_contribution) * base_ease + link_contribution * average_ease
    link_contribution = max_link_factor * min(1.0, log(link_count + 0.5) / log(64))
```

--------------------------------

### Commit and push version bump changes

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/contributing.md

Committing and pushing changes after bumping the plugin version.

```bash
git add .
git commit -m "chore: bump version to v1.9.2"
git push --set-upstream origin release-v1.9.2
```

--------------------------------

### Formatting Code

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/contributing.md

Command to format the code to fix any linter warnings.

```bash
pnpm format
```

--------------------------------

### Toggle mobile view in developer console

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/zh/contributing.md

JavaScript code to toggle between desktop and mobile views in the Obsidian developer console.

```javascript
this.app.emulateMobile(false); // Switch to desktop view

this.app.emulateMobile(true); // Switch to mobile view
```

--------------------------------

### Multi-line Basic

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/flashcards/q-and-a-cards.md

A multi-line flashcard where the prompt and answer are separated by '?'. Both prompt and answer can span multiple lines.

```markdown
As per the definition
of "multiline" the prompt
can be on multiple lines
?
same goes for
the answer
```

--------------------------------

### Multiple Custom Cloze Patterns

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/flashcards/cloze-cards.md

Adding multiple custom cloze patterns to settings, separated by new lines.

```text
{{[123::]answer[::hint]}}
==answer==[^\[hint\]][\[^123\]]
```

--------------------------------

### Interval Fuzzing for Long Intervals

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/wiki/Spaced-Repetition-Algorithm

Applies a small random fuzz to intervals of 8 days or more to prevent reviews from clustering on the same day.

```plaintext
interval += random_choice({-fuzz, 0, +fuzz})
where fuzz = ceil(0.05 * interval)
```

--------------------------------

### Interval Adjustment Based on Review Difficulty

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/wiki/Spaced-Repetition-Algorithm

Adjusts the review interval based on whether a concept is reviewed as easy, good, or hard, including an easy bonus and a minimum ease.

```plaintext
easy: ease increases by 20, interval = old_interval * new_ease / 100 * 1.3 (easy bonus)
good: ease unchanged, interval = old_interval * old_ease / 100
hard: ease decreases by 20, interval = old_interval * 0.5 (minimum ease = 130)
```

--------------------------------

### Single-line Bidirectional

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/flashcards/q-and-a-cards.md

A single-line flashcard that creates two bidirectional cards, separated by ':::'.

```markdown
info 1:::info 2
```

--------------------------------

### Multi-line Bidirectional

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/main/docs/docs/en/flashcards/q-and-a-cards.md

A multi-line flashcard that creates two bidirectional cards, separated by '??'. Both parts can span multiple lines.

```markdown
info 1A
info 1B
info 1C
??
info 2A
info 2B
```

--------------------------------

### Single-line Reversed Flashcard

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/wiki/Flashcard-Types

Creates two cards: one with side1 as prompt and side2 as answer, and another reversed card with side2 as prompt and side1 as answer. Separated by ':::'. Configurable in settings.

```markdown
the question goes on this side:::answer goes here!
```

--------------------------------

### Single-line Basic Flashcard

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/wiki/Flashcard-Types

A basic flashcard where the question and answer are on a single line, separated by '::'. This format is configurable in the plugin settings.

```markdown
the question goes on this side::answer goes here!
```

--------------------------------

### Multi-line Basic Flashcard

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/wiki/Flashcard-Types

A basic flashcard where the front and back can span multiple lines, separated by '?'. Both sides must 'touch' the separator.

```markdown
Front of multiline
?
Backside of multiline card
```

```markdown
As per the definition
of "multiline" the prompt
can be on multiple lines
?
same goes for
the answer
```

--------------------------------

### Multi-line Reversed Flashcard

Source: https://github.com/st3v3nmw/obsidian-spaced-repetition/wiki/Flashcard-Types

Creates two cards (forward and reversed) where the front and back can span multiple lines, separated by '??'. Both sides must 'touch' the separator.

```markdown
Front of multiline
??
Backside of multiline card
```

```markdown
As per the definition
of "multiline" the prompt
can be on multiple lines
??
same goes for
the answer
```
Tokens:
Raw