{"id":25588233,"url":"https://github.com/urnote/urnote","last_synced_at":"2025-04-12T21:41:36.933Z","repository":{"id":62586666,"uuid":"83258278","full_name":"urnote/urnote","owner":"urnote","description":"A program that utilizes spaced repetition to review your notes written in Markdown","archived":false,"fork":false,"pushed_at":"2020-08-22T02:44:06.000Z","size":501,"stargazers_count":42,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-10T00:12:49.972Z","etag":null,"topics":["command-line","markdown","note","review","review-tools","spaced-repetition","spaced-repetition-system"],"latest_commit_sha":null,"homepage":"https://urnote.github.io/urnote","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/urnote.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-02-27T02:08:44.000Z","updated_at":"2024-09-03T04:32:08.000Z","dependencies_parsed_at":"2022-11-03T22:39:23.676Z","dependency_job_id":null,"html_url":"https://github.com/urnote/urnote","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/urnote%2Furnote","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/urnote%2Furnote/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/urnote%2Furnote/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/urnote%2Furnote/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/urnote","download_url":"https://codeload.github.com/urnote/urnote/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248637832,"owners_count":21137538,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["command-line","markdown","note","review","review-tools","spaced-repetition","spaced-repetition-system"],"created_at":"2025-02-21T08:26:21.635Z","updated_at":"2025-04-12T21:41:36.915Z","avatar_url":"https://github.com/urnote.png","language":"Python","readme":"# Urnote\n\nUrnote是一个用来复习MarkDown笔记的工具。 \n\n## 快速开始\n\n1. `pip install urnote`\n2. `cd 你的MarkdDown笔记目录/`\n3. `note init`\n\n## 示例\n\n创建了一个hello.md文件, 内容如下:\n\n```markdown\n# Are you ok ?\n\nI am fine\n```\n\nUrnote通过标题末尾的问号识别需要安排复习的章节, 执行 `note commit` 后该章节将被加入复习计划。加入复习计划后, 标题的格式会变成这样:\n\n```markdown\n# Are you ok [?](1)\n\nok\n```\n\n之后每天需要复习的时候执行下 `note status` 命令, 如果发现有需要当天复习的内容, Urnote会创建`TASK/`目录并在里面展示需要复习的笔记。\n\n进入TASK目录打开文件,会发现之前的[❓]()变成了[🔔](),该符号用来提示条目需要复习。之后在🔔后面添加符号告诉Urnote复习结果:\n\n- 如果记得,标注V\n- 如果不记得,标注X\n\n完成标注后执行`note commit`提交即可.\n\n## 章节状态\n\n在Urnote中,一个章节总共有4种状态: 普通,处于复习计划,需要复习,暂停复习.\n\n**处于复习计划**\n\n处于复习计划的章节以符号\"❓\"结束.\n\n**需要复习**\n\n符号 \"🔔\" 结束表示该条目需要复习.\n\n**暂停复习**\n\n 符号\"📕\"表示该章节暂时退出了复习计划(不再提醒).\n\n## 状态转变\n\n| 状态     | 可用的控制字符 | 意义                   |\n| ------ | ------- | -------------------- |\n| 普通     | ?       | 将普通笔记加入复习计划,将加入复习计划. |\n| 需要复习🔔 | V       | 表示记得,将继续处于复习计划中      |\n|        | X       | 表示不记得,将继续处于复习计划中     |\n|        | P       | 表示暂停本次笔记,将转入暂停复习的状态  |\n| 暂停复习📕 | C       | 表示继续学习该笔记,将加入复习计划    |\n\n上面所有的字符均不区分大小写和全角.\n\n![状态转移图](./docs/res/state_transitions.png)\n\n## 命令行参数\n\n执行 `note -h` 或者 `note --help` 查看所有命令，如果要查看某个命令的具体用法可以 `note 命令名 --help`, 如 `note commit --help`\n\n## Road Map\n\n- [ ] 复习时间到了自动提醒\n- [ ] 复习算法初始值自动调整\n- [ ] 提前复习支持,即还没到复习时间的也可以提交[XVP]\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Furnote%2Furnote","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Furnote%2Furnote","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Furnote%2Furnote/lists"}