Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix different device sync issue #85

Closed
wants to merge 178 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
178 commits
Select commit Hold shift + click to select a range
98cab1c
Merge branch 'local-dev'
Newdea Jun 19, 2023
643f2f6
Merge branch 'hotfix-savejson'
Newdea Jun 20, 2023
4855a6f
Squashed commit of the following:
Newdea Jul 8, 2023
f9c9e09
Squashed commit of the following:
Newdea Jul 8, 2023
5e1d965
fix: wrong status notes counts
Newdea Jul 10, 2023
0c28074
Squashed commit of the following:
Newdea Jul 13, 2023
3d505db
fix statusbar notes counts error when delete taged file
Newdea Jul 13, 2023
c867f6c
add writeRevlog for optimizer
Newdea Jul 22, 2023
0353e73
fix: pruneData id
Newdea Jul 22, 2023
7f29696
fix: responseOptionBtnsText
Newdea Jul 22, 2023
6774d93
隐藏暂不用的设置项
Newdea Jul 22, 2023
3d7d463
fix lint warns
Newdea Jul 22, 2023
fd976b0
revlog stuffs
Newdea Jul 23, 2023
fb17e85
fix revlog
Newdea Jul 23, 2023
0b036b6
appendRevlog
Newdea Jul 23, 2023
f227f42
fix: noteFoldersToIgnore change to wild matches
Newdea Jul 23, 2023
0cc47a3
fix pruneData
Newdea Jul 23, 2023
9045dd3
fix pruneData with revlog
Newdea Jul 23, 2023
4f9382d
change filname: ob_revlog
Newdea Jul 23, 2023
72eccab
update readme
Newdea Jul 23, 2023
e989575
formate and version update
Newdea Jul 23, 2023
e1b8310
feat: 输出csv日志文件
Newdea Jul 25, 2023
e54fdb2
Feat/FSRSv4 (#1)
L-M-Sherlock Jul 27, 2023
52e5c10
Feat/update fsrs.js to 1.1.0 (#2)
L-M-Sherlock Jul 29, 2023
65c6e3a
Release-v1.10.1.5 (#3)
Newdea Jul 30, 2023
59a8c27
fix revlog (#5)
Newdea Aug 5, 2023
bea3861
update version
Newdea Aug 5, 2023
aa6c725
fix buid err
Newdea Aug 5, 2023
d57469f
hotfix: isArray
Newdea Aug 5, 2023
cbfb0eb
update lock file
Newdea Aug 9, 2023
e27c02d
update pr
Newdea Aug 9, 2023
0f4db91
bug fix null
Newdea Aug 11, 2023
5d86c0b
new day new queue
Newdea Aug 11, 2023
c26609e
update readme
Newdea Aug 14, 2023
52cff45
feat: open note file
Newdea Aug 14, 2023
508d2ae
formate
Newdea Aug 14, 2023
bf60964
sym link
Newdea Aug 14, 2023
360b277
merge master
Newdea Aug 14, 2023
972a77c
trailingComma: all
Newdea Aug 14, 2023
96f31a8
ShowReleaseNotes
Newdea Aug 14, 2023
4d03ede
add releaseNotes
Newdea Aug 14, 2023
a92a64d
setting: add issue url
Newdea Aug 14, 2023
95d3a2e
words fix
Newdea Aug 14, 2023
c833b2a
update changlog
Newdea Aug 14, 2023
ca7c3b1
update readme
Newdea Aug 14, 2023
e53bb9c
update release
Newdea Aug 14, 2023
cabe86f
Update styles.css
WwwZMing Aug 18, 2023
c33c720
Merge pull request #10 from WwwZMing/increaseclick
Newdea Aug 19, 2023
9a82c6d
chore: pretty
Newdea Aug 19, 2023
cba6603
fix reg
Newdea Aug 15, 2023
b48fb24
del debug
Newdea Aug 15, 2023
efb4cf7
when buildQueue don't untrackfile
Newdea Aug 15, 2023
ad3459b
fix: untrackFilesInFolder
Newdea Aug 15, 2023
6fca9f8
buildQueue
Newdea Aug 15, 2023
d99588f
fix: plugin
Newdea Aug 15, 2023
2d8e911
msg
Newdea Aug 15, 2023
dbfbb81
update readme
Newdea Aug 17, 2023
2653ddc
fix Nan
Newdea Aug 18, 2023
4b9076b
symlink
Newdea Aug 19, 2023
5a58561
lint and update readme
Newdea Aug 19, 2023
093772b
fix pluginname
Newdea Aug 19, 2023
cb03c84
fix #11, backup tracked_files.json when change data Location
Newdea Aug 22, 2023
a5dc3e7
- big update: dataLocation switch.**be careful !!!**, if you switch…
Newdea Aug 26, 2023
5f25a9f
fix #12, #14, data didn't save after reviewing.
Newdea Aug 27, 2023
c4076e6
update chore
Newdea Aug 29, 2023
81d72ff
save fix
Newdea Aug 30, 2023
8b28e04
fix #15, review tag
Newdea Sep 10, 2023
dbc792c
noteStats
Newdea Sep 10, 2023
2ccbda8
refactor: Separate business logic from user interface code (#751)
ronzulu Oct 4, 2023
54d0a21
Bump version to 1.10.2 (#756)
st3v3nmw Oct 9, 2023
232f506
Fix bugs regarding bury sibling cards (#763)
ronzulu Oct 18, 2023
b39b61d
doc: update note about the reversed card (#699)
khoinguyen Oct 20, 2023
6a58137
Bump version to v1.10.3 (#772)
st3v3nmw Oct 23, 2023
af15f8d
Bug fix: questions now removed from postponement list; etc (#775)
ronzulu Oct 26, 2023
6cd2878
fix: multi-line tag ('$$') converted to single-line ('$') after card …
ronzulu Oct 30, 2023
597aa57
Bump version to v1.10.4 (#780)
st3v3nmw Oct 30, 2023
353407a
Bug note review invalid metadata 764 (#782)
ronzulu Nov 12, 2023
cc64259
Bug edit flashcard sometimes corrupts question text in file (#784)
ronzulu Nov 12, 2023
eb25a0a
Bump version to v1.10.5 (#789)
st3v3nmw Nov 12, 2023
1dc9f7e
Squashed commit of the following:
Newdea Nov 28, 2023
0d73be6
prettier and lockfile fix
Newdea Dec 1, 2023
3da233c
bump version 1.10.5.2
Newdea Dec 3, 2023
f9ef6c8
bump version to 1.10.5.3 :
Newdea Dec 8, 2023
a64d8d8
- fix cardtext change
Newdea Dec 16, 2023
8d150e5
update chore
Newdea Dec 16, 2023
4c7841a
prettier
Newdea Dec 16, 2023
0cddfc8
add prettier
Newdea Dec 29, 2023
be95d2f
chore: update docs
Newdea Dec 30, 2023
6bb378e
update action
Newdea Dec 30, 2023
c7fb9f6
update action
Newdea Dec 30, 2023
eb9dcd7
fix #34, untrack error
Newdea Jan 14, 2024
a850092
Merge branch 'dev-master'
Newdea Jan 14, 2024
b6351a0
chore: version
Newdea Jan 14, 2024
4b34588
fix merge
Newdea Jan 14, 2024
088b72d
fix merge
Newdea Jan 14, 2024
29ab434
git action write
Newdea Jan 14, 2024
edae481
Prettified Code!
Newdea Jan 14, 2024
7268d20
Merge pull request #39 from open-spaced-repetition/merge/master
Newdea Jan 14, 2024
d73d951
chore: bump version
Newdea Jan 14, 2024
1b83954
update action
Newdea Jan 14, 2024
911fc2a
update lang
Newdea Jan 14, 2024
ce3249b
fix undefind
Newdea Jan 14, 2024
8ea6beb
Merge branch 'master'
Newdea Jan 26, 2024
1ac57ee
fix conflict
Newdea Feb 6, 2024
65e3160
Prettified Code!
Newdea Feb 7, 2024
f01e776
Merge pull request #41 from open-spaced-repetition/merge/master
Newdea Feb 7, 2024
388b1ec
- fix: 当天新卡片复习后,当天无法再次复习 的问题;
Newdea Feb 7, 2024
e54b300
bump version to v1.11.1.2
Newdea Feb 7, 2024
c2ed1eb
Prettified Code!
Newdea Feb 7, 2024
f0f8f57
Merge pull request #42 from open-spaced-repetition/release
Newdea Feb 7, 2024
f77e834
add reschedule and postpone (#43)
Newdea Feb 17, 2024
39bb043
Merge remote-tracking branch 'st3v3nmw/master'
Newdea Feb 18, 2024
4b835ea
Prettified Code!
Newdea Feb 18, 2024
d3f8ab1
Merge branch 'st3v3nmw/master'
Newdea Feb 18, 2024
1e50c53
- fix review new note;
Newdea Feb 18, 2024
d1ce86f
chore: update docs
Newdea Feb 18, 2024
e8bf3f3
fix lint error
Newdea Feb 18, 2024
5ab2b85
fix lint error
Newdea Feb 19, 2024
296097e
chore: update version
Newdea Feb 19, 2024
0223b23
refactor review
Newdea Feb 19, 2024
eaf4cde
add multi cloze support
Newdea Feb 19, 2024
14d963d
limit clozes to 4
Newdea Feb 19, 2024
d943d2e
del debug msg
Newdea Feb 19, 2024
a36b8f1
refactor
Newdea Feb 19, 2024
5a74d34
add setting
Newdea Feb 19, 2024
31d6dbf
fix error
Newdea Feb 19, 2024
352ccc7
fix update reviewDecks
Newdea Feb 22, 2024
c282be1
Merge branch 'fix/reviewdeck'
Newdea Feb 22, 2024
fde045a
Merge branch 'st_master' into dev/justmerge
Newdea Jun 18, 2024
609c06a
fix merge error
Newdea Jun 18, 2024
70e099d
add debug msg
Newdea Jun 21, 2024
d0de74b
auto review next after postpone a note
Newdea Jun 21, 2024
c2a1f20
Merge branch 'Feat/autonext'
Newdea Jun 21, 2024
cc9d9db
fix #45 bury siblings
Newdea Jun 22, 2024
01771a8
Merge branch 'fix/hidesibling'
Newdea Jun 22, 2024
cc788fc
fix sidebar padding
Newdea Jun 22, 2024
7678ee0
show cards info
Newdea Jun 22, 2024
296fccd
fix sidebar padding
Newdea Jun 22, 2024
88f4ffb
switch to ts-fsrs
Newdea Jun 22, 2024
d86357c
add debug info
Newdea Jun 22, 2024
f6876f4
update debug func
Newdea Jun 22, 2024
7408f75
fix #53
Newdea Jun 22, 2024
f70127c
chore: update docs
Newdea Jun 22, 2024
641fd28
Merge branch 'hotfix/reviewDueNow'
Newdea Jun 22, 2024
65a04da
chore: update version
Newdea Jun 22, 2024
faac1d5
fix test error
Newdea Jun 22, 2024
47ae13f
fix lint error
Newdea Jun 22, 2024
1b41257
Merge pull request #55 from open-spaced-repetition/dev/justmerge
Newdea Jun 22, 2024
c79d0a2
hide popup message
Newdea Jun 22, 2024
27109e5
fix: #54 #56 复习时打开了没到期的笔记
Newdea Jun 23, 2024
2bb88ae
fix#56 #58 (#61)
Newdea Jun 26, 2024
14b9a60
blockid newandDue iteminfo (#65)
Newdea Jul 21, 2024
aaf03a2
update version 12.4.8
Newdea Jul 21, 2024
d5d0a15
Merge branch 'master' into mg/st_master
Newdea Jul 21, 2024
3d644b3
fix merge
Newdea Jul 21, 2024
108fe5a
fix isdue
Newdea Jul 22, 2024
cdb6646
fix 0due or 0new
Newdea Jul 22, 2024
ccd0794
sort new notes by file create time only.
Newdea Aug 6, 2024
1999f53
Merge branch 'fix/#67_mixque'
Newdea Aug 6, 2024
34699dc
Merge branch 'fix/sortNewNotes'
Newdea Aug 6, 2024
9020dd9
chore: update version
Newdea Aug 6, 2024
4143589
Merge pull request #69 from open-spaced-repetition/release/1.12.4.9
Newdea Aug 13, 2024
6a1f75b
fix linting, bump dependencies
st3v3nmw Aug 25, 2024
4c0bf01
add tagsToIgnore setting
Newdea Aug 29, 2024
e83ad78
Merge branch 'Feat/ignoredTags' into mg/upmaster
Newdea Aug 29, 2024
c57f011
update settings UX
Newdea Aug 30, 2024
7e5d1a8
udpate to use fsrs v5
Newdea Aug 30, 2024
269e645
Merge branch 'Feat/fsrs5' into mg/upmaster
Newdea Aug 30, 2024
dab5c42
fix deprecated var app
Newdea Aug 30, 2024
82a2ae7
fix settings
Newdea Aug 30, 2024
a828d97
update version and docs
Newdea Aug 30, 2024
cf4bebc
fix test errors
Newdea Aug 30, 2024
0244787
## [1.12.5.10] (#74)
Newdea Aug 30, 2024
bdd7f19
Merge remote-tracking branch 'origin/dev-master' into mg/upmaster
Newdea Aug 30, 2024
abcf81b
Merge pull request #75 from open-spaced-repetition/mg/upmaster
Newdea Aug 30, 2024
daf7a12
Feat/Add two feature toggles (#78)
ishiko732 Sep 2, 2024
99a54d1
1.12.5.11 (#80)
Newdea Sep 4, 2024
6d8d92b
blockid #81 #83
Newdea Oct 10, 2024
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
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
name: Bug report
about: Create a bug report to help us improve the plugin.
title: "[BUG]"
labels: bug
assignees: ""
---

**Before report the bug**

- [ ] searched the issues;
- [ ] disable origin `Obsidian Sapced Repetition` plugin;

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain the bug. This could be the logs in the developer console (`CTRL` + `SHIFT` + `i`).

- [ ] error messages

**Versions (please complete the following information):**

- [ ] OS: [e.g. iOS]
- [ ] Obsidian version: [e.g. v0.12.4]
- [ ] Plugin version: [e.g. v1.4.9]
- [ ] If on desktop, Installer version: [run `this.navigator.appVersion` on the developer console, e.g. `5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) obsidian/0.12.3 Chrome/89.0.4389.128 Electron/12.0.6 Safari/537.36"`]

**Additional context**
Add any other context about the problem here (e.g. the markdown producing the error).

- Data Location Setting(select):
- [ ] Save in Note;
- [ ] Save in `tracked_files.json`
- Algorithm(select):
- [ ] Default
- [ ] Anki
- [ ] Fsrs
- [ ] SM2
- [ ] Additional context
Binary file added .github/funding/QR_alipay.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/funding/QR_wechat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion .github/workflows/e2e.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: "20"
node-version: "22"

- uses: actions/checkout@v3

Expand Down
55 changes: 53 additions & 2 deletions .github/workflows/pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,71 @@ name: Lint and Test

on:
pull_request:
branches: [master]
branches: ["**"]
push:
branches:
- "**"

env:
COREPACK_ENABLE_STRICT: 0

jobs:
# https://github.com/snezhig/obsidian-front-matter-title/blob/master/.github/workflows/main.yml
validate:
if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
with:
submodules: "true"
- name: Install Dependencies
run: npm install -g pnpm && pnpm install

- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v4
with:
node-version: "22"
cache: "pnpm"
- run: pnpm i

# - name: Eslint
# run: pnpm run lint

- name: Run test
run: pnpm run test

pretty:
needs: validate
runs-on: ubuntu-latest
# if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == 'Newdea/obsidian-spaced-repetition-recall'
permissions: write-all

steps:
- name: Checkout
uses: actions/checkout@v3
with:
# Make sure the actual branch is checked out when running on pull requests
ref: ${{ github.head_ref }}

- name: Prettify code
uses: creyD/[email protected]
with:
prettier_version: ^3.1.1
# This part is also where you can pass other options, for example:
# prettier_options: --write *.ts *.json src test --ignore-path package-lock.json
# --config .prettierrc.json --ignore-path package-lock.json pnpm-lock.yaml
prettier_options: --write .

lint_and_test:
needs: pretty
runs-on: ubuntu-latest

steps:
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: "20"
node-version: "22"

- uses: actions/checkout@v3

Expand Down
6 changes: 4 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@ on:
- "*"

env:
PLUGIN_NAME: obsidian-spaced-repetition
PLUGIN_NAME: obsidian-spaced-repetition-recall
COREPACK_ENABLE_STRICT: 0

permissions: write-all

jobs:
release:
runs-on: ubuntu-latest
Expand All @@ -19,7 +21,7 @@ jobs:
- name: Use Node.js
uses: actions/setup-node@v4
with:
node-version: "20"
node-version: "22"

- name: Build
id: build
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ yarn-error.log

# build
build
config.js

# testing
coverage
Expand Down
2 changes: 1 addition & 1 deletion .npmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
use-node-version=20.1.0
use-node-version=22.2.0
3 changes: 2 additions & 1 deletion .prettierrc.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"printWidth": 100,
"tabWidth": 4,
"semi": true
"semi": true,
"trailingComma": "all"
}
2 changes: 1 addition & 1 deletion CHANGELOG.md
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
85 changes: 57 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,71 @@
This is a modified version of [obsidian-spaced-repetition](https://github.com/st3v3nmw/obsidian-spaced-repetition) and merging [recall plugin](https://github.com/martin-jw/obsidian-recall) to use seperate json data file, and add some interesting features.

就是 SR 的时间排程信息可以单独保存,~~不修改原笔记文件内容~~(如果卡片复习,开启blockid设置,会在卡片文本后追加BlockID),以及添加其他功能。

# Flashcard-Based and Note-Based Spaced Repetition Plugin

<img src="https://img.shields.io/github/downloads/st3v3nmw/obsidian-spaced-repetition/total" /> <img src="https://img.shields.io/github/downloads/st3v3nmw/obsidian-spaced-repetition/latest/total?style=flat-square" /> <img src="https://img.shields.io/github/manifest-json/v/st3v3nmw/obsidian-spaced-repetition?style=flat-square" />
## Features

Fight the forgetting curve & note aging by reviewing flashcards & notes using spaced repetition on Obsidian.md
- [@st3v3nmw's ReadMe](https://github.com/st3v3nmw/obsidian-spaced-repetition#readme)
- [中文使用手册](./docs/README_ZH.md)

- Check the documentation [here](https://www.stephenmwangi.com/obsidian-spaced-repetition/).
- Check the [roadmap](https://github.com/st3v3nmw/obsidian-spaced-repetition/projects/3/) for upcoming features & fixes.
- Raise an issue [here](https://github.com/st3v3nmw/obsidian-spaced-repetition/issues/) if you have a feature request or a bug report.
- Visit the [discussions](https://github.com/st3v3nmw/obsidian-spaced-repetition/discussions/) section for Q&A help, feedback, and general discussion.
- The plugin has been translated into _Arabic / العربية, Chinese (Simplified) / 简体中文, Chinese (Traditional) / 繁體中文, Czech / čeština, German / Deutsch, Italian / Italiano, Korean / 한국어, Japanese / 日本語, Polish / Polski, Portuguese (Brazil) / Português do Brasil, Spanish / Español, and Russian / русский_ by the Obsidian community 😄.
- To help translate this plugin to your language, check the [translation guide here](https://www.stephenmwangi.com/obsidian-spaced-repetition/contributing/#translating_1).
- merge [recall plugin](https://github.com/martin-jw/obsidian-recall) to use seperate file
- setting where to save schedule info by Data Location
- save on note file, just as used do.
- save on seperate tracked_files.json.
- setting convert tracked note to decks
- switch Algorithm(only work on saving on seperate tracked_files.json.): Default, anki, [Fsrs](https://github.com/open-spaced-repetition/ts-fsrs)
- file menu to tracknote/untracknote
- show floatbar for reviewing response when reviewing note by click statusbar or review command or sidebar, and can set whether showing the interval or not;
- Reviewing a Notes directly [#635];
- when using fsrs, output `ob-revlog.csv`, to optimize the algorithm parameters using [optimizer](https://github.com/open-spaced-repetition/fsrs-optimizer) for better review;
- Statistics: add note view statistics,and today review statistics;
- Postpone notes/cards;
- postpone to review after x days;
- reschedule all scheduled items;
- support multi-clozes;
- setting `burySiblingCards` split into `burySiblingCards`(origin) and `burySiblingCardsByNoteReview`, and multi-clozes will not be buried;
- Setting: Card index uses BlockID, which appends BlockID (e.g. `^blkid1`) to the card text, **will modify the original notes file**. Off by default, but card index may not be accurate enough;
- Setting: Mix ondue and new notes queue when reviewing(default: 3 ondue notes, then 2 new notes);

## Features
## Maintainers Wanted

Since I am not a programmer, I don't know much about typescript programming, so I can only do some bug fixes and small feature updates. but it is difficult to realize some of the proposed features. Welcome to join us if you are interested in this plugin, and work together to maintain and update this plugin.

You can join us by submitting an [issue](https://github.com/open-spaced-repetition/obsidian-spaced-repetition-recall/issues)/[PR](https://github.com/open-spaced-repetition/obsidian-spaced-repetition-recall/pulls)、或[论坛讨论](https://forum-zh.obsidian.md/t/topic/20551) directly.

## How to install the plugin

- Flashcards
- [Decks](https://www.stephenmwangi.com/obsidian-spaced-repetition/flashcards/#decks) (Using Obsidian's hierarchical tags or folder structure)
- [Single-line style](https://www.stephenmwangi.com/obsidian-spaced-repetition/flashcards/#single-line-basic-remnote-style) (`Question::Answer`)
- [Single-line reversed style](https://www.stephenmwangi.com/obsidian-spaced-repetition/flashcards/#single-line-reversed) (`Question:::Answer`)
- [Multi-line style](https://www.stephenmwangi.com/obsidian-spaced-repetition/flashcards/#multi-line-basic) (Separated by `?`)
- [Multi-line reversed style](https://www.stephenmwangi.com/obsidian-spaced-repetition/flashcards/#multi-line-reversed) (Separated by `??`)
- [Cloze cards](https://www.stephenmwangi.com/obsidian-spaced-repetition/flashcards/#cloze-cards) (`==highlight==` your cloze deletions!, `**bolded text**`, or `{{text in curly braces}}`)
- [Card context - automatic titles based on headings](https://www.stephenmwangi.com/obsidian-spaced-repetition/flashcards/#context) (i.e. `Note title > Heading 1 > Subheading`)
- Rich text support in flashcards (inherited from Obsidian)
- Images, Audio, & Video
- LaTeX
- Code syntax highlighting
- Footnotes
- Notes
- [Reviewing entire notes](https://www.stephenmwangi.com/obsidian-spaced-repetition/notes/)
- Possible use case: [Incremental writing](https://www.stephenmwangi.com/obsidian-spaced-repetition/notes/#incremental-writing)
- [Statistics](https://www.stephenmwangi.com/obsidian-spaced-repetition/flashcards/#statistics)
1. Download main.js, manifest.json, styles.css from the latest release (see [releases](https://github.com/open-spaced-repetition/obsidian-spaced-repetition-recall/releases/))
2. Create a new folder `obsidian-spaced-repetition-recall` in `Vault-name/.obsidian/plugins` and put the downloaded files in there
3. Reload your plugins and enable the plugin

OR USE BRAT pulgin;

## Usage

Check the [docs](https://www.stephenmwangi.com/obsidian-spaced-repetition/) for more details.
Check the [docs](./docs/usage.md) for more details.

## Thanks

I develop this plugin as a hobby, spending my free time doing this. If you find it valuable, then please say THANK YOU or buy me a coffee...

<div class="ex-coffee-div" align = "center">
<a ><img src="https://github.com/Newdea/newdea/blob/main/.github/funding/QR_alipay.png?v=3" height=120></a>
<a ><img src="https://github.com/Newdea/newdea/blob/main/.github/funding/QR_wechat.png?v=3" height=120></a>
</div>

or buy original plugin author(@st3v3nmw) a coffee...

## Supported By

<a href='https://ko-fi.com/M4M44DEN6' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://cdn.ko-fi.com/cdn/kofi3.png?v=2' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>

<a href="https://jb.gg/OpenSourceSupport" target="_blank"><img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" height='128' style='border:0px;height:128px;' alt="JetBrains Logo (Main) logo."></a>
---

Thank you to everyone who has created a plugin that inspired me and I took code from.

- first, thanks to [@st3v3nmw's obsidian-spaced-repetition](https://github.com/st3v3nmw/obsidian-spaced-repetition) and [@martin-jw recall plugin](https://github.com/martin-jw/obsidian-recall)
- floatbar(thanks to [@chetachi's cMenu](https://github.com/chetachiezikeuzor/cMenu-Plugin))
- [Fsrs Algorithm](https://github.com/open-spaced-repetition)
- ReleaseNotes(thanks to [@Zsolt Viczian Excalidraw](https://zsolt.blog))
76 changes: 76 additions & 0 deletions docs/README_ZH.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
本插件是魔改自[obsidian-spaced-repetition](https://github.com/st3v3nmw/obsidian-spaced-repetition) 和 [recall plugin](https://github.com/martin-jw/obsidian-recall)
就是 SR 的复习时间信息可以单独保存,~~不修改原笔记文件内容~~(如果卡片复习,开启blockid设置,会在卡片文本后追加BlockID),以及添加其他功能。

## Features

- [@st3v3nmw's ReadMe](https://github.com/st3v3nmw/obsidian-spaced-repetition#readme)
- [english ReadMe](../README.md)

1. 复习时间信息可以保存在单独文件内,不修改原笔记文件内容;
2. 在复习笔记时可以显示悬浮栏(跟复习卡片时类似),方便选择记忆效果,且可显隐到下次重复的时间间隔;
3. 可以只转换复习笔记到卡片组,而不是全部库的笔记都转换;
4. 在有多个标签时,可不用选标签,直接打开笔记;
5. 算法可以切换:默认的 Anki 优化算法、Anki 算法、[Fsrs 算法](https://github.com/open-spaced-repetition/ts-fsrs);
6. 使用 Fsrs 算法时,可根据标签输出重复日志文件 `ob_revlog.csv`,以使用[optimizer](https://github.com/open-spaced-repetition/fsrs-optimizer) 优化算法参数,达到更好的复习效果;
7. 数据表中新增笔记复习情况、当天复习情况;
8. 延后笔记/卡片;
9. 修改笔记/卡片在x天后复习;
10. 重排所有已排程的复习项;
11. 支持多个挖空;
12. 设置项 隐藏关联卡片拆分为 隐藏关联卡片(即原来的)和复习笔记时隐藏关联卡片;另,多个挖空不会被隐藏关联卡片;
13. 设置项: 卡片定位使用BlockID,会在卡片文本后追加BlockID (e.g. `^blkid1`),**即修改了原笔记文件**。默认关闭,但卡片定位可能不太准确,但也够用;
14. 设置项: 复习笔记时,复习顺序可混合新旧笔记(默认: 3篇到期的,然后2篇新的笔记);
15. 其他待发现的小改动;

**注意**
没有使用过 obsidian-spaced-repetition 插件的可以直接用,正在使用 obsidian-spaced-repetition 插件的话,建议试用前先备份 :yum:

欢迎大家试用讨论

## 欢迎加入

因我本人并不是程序员,对 typescript 编程有许多不懂的地方,目前只能做些 bug 修复、及小功能更新。而对一些好的功能建议就难以实现了,欢迎对这个插件感兴趣的朋友加入,一起维护更新这个插件。

加入方式直接提 [issue](https://github.com/open-spaced-repetition/obsidian-spaced-repetition-recall/issues)/[PR](https://github.com/open-spaced-repetition/obsidian-spaced-repetition-recall/pulls)、或[论坛讨论](https://forum-zh.obsidian.md/t/topic/20551) 。

## 适用场景

1. 间隔重复复习;
2. 渐进式总结;
3. 增量写作;

更详细内容请参考 [使用教程](使用教程.md).

## 下载

推荐 BRAT 直接添加 github 链接更方便些

github: https://github.com/open-spaced-repetition/obsidian-spaced-repetition-recall

或:

1. 从[最新发布](https://github.com/open-spaced-repetition/obsidian-spaced-repetition-recall/releases/)中下载压缩包(已包括 main.js, manifest.json, styles.css);
2. 在 `Vault-name/.obsidian/plugins` 中,把刚下的文件解压(应是`obsidian-spaced-repetition-recall`文件夹)放入`plugins`文件夹下;
3. 重启 Obsidan 开启插件,就可以使用了。

## Thanks

业余时间折腾的,如果对你有所帮助,可以请我喝瓶饮料或奶茶呀~

<div class="ex-coffee-div" align = "center">
<a ><img src="https://github.com/Newdea/newdea/blob/main/.github/funding/QR_alipay.png?v=3" height=120></a>
<a ><img src="https://github.com/Newdea/newdea/blob/main/.github/funding/QR_wechat.png?v=3" height=120></a>
</div>

或者,请原插件作者(@st3v3nmw)喝杯咖啡

<a href='https://ko-fi.com/M4M44DEN6' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://cdn.ko-fi.com/cdn/kofi3.png?v=2' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>

---

Thank you to everyone who has created a plugin that inspired me and I took code from.

- first, thanks to [@st3v3nmw's obsidian-spaced-repetition](https://github.com/st3v3nmw/obsidian-spaced-repetition) and [@martin-jw recall plugin](https://github.com/martin-jw/obsidian-recall)
- floatbar(thanks to [@chetachi's cMenu](https://github.com/chetachiezikeuzor/cMenu-Plugin))
- [Fsrs Algorithm](https://github.com/open-spaced-repetition)
- ReleaseNotes(thanks to [@Zsolt Viczian Excalidraw](https://zsolt.blog))
Loading
Loading