Giter VIP home page Giter VIP logo

urnote's Introduction

Urnote

Urnote是一个用来复习MarkDown笔记的工具。

快速开始

  1. pip install urnote
  2. cd 你的MarkdDown笔记目录/
  3. note init

示例

创建了一个hello.md文件, 内容如下:

# Are you ok ?

I am fine

Urnote通过标题末尾的问号识别需要安排复习的章节, 执行 note commit 后该章节将被加入复习计划。加入复习计划后, 标题的格式会变成这样:

# Are you ok [?](1)

ok

之后每天需要复习的时候执行下 note status 命令, 如果发现有需要当天复习的内容, Urnote会创建TASK/目录并在里面展示需要复习的笔记。

进入TASK目录打开文件,会发现之前的变成了🔔,该符号用来提示条目需要复习。之后在🔔后面添加符号告诉Urnote复习结果:

  • 如果记得,标注V
  • 如果不记得,标注X

完成标注后执行note commit提交即可.

章节状态

在Urnote中,一个章节总共有4种状态: 普通,处于复习计划,需要复习,暂停复习.

处于复习计划

处于复习计划的章节以符号"❓"结束.

需要复习

符号 "🔔" 结束表示该条目需要复习.

暂停复习

符号"📕"表示该章节暂时退出了复习计划(不再提醒).

状态转变

状态 可用的控制字符 意义
普通 ? 将普通笔记加入复习计划,将加入复习计划.
需要复习🔔 V 表示记得,将继续处于复习计划中
X 表示不记得,将继续处于复习计划中
P 表示暂停本次笔记,将转入暂停复习的状态
暂停复习📕 C 表示继续学习该笔记,将加入复习计划

上面所有的字符均不区分大小写和全角.

状态转移图

命令行参数

执行 note -h 或者 note --help 查看所有命令,如果要查看某个命令的具体用法可以 note 命令名 --help, 如 note commit --help

Road Map

  • 复习时间到了自动提醒
  • 复习算法初始值自动调整
  • 提前复习支持,即还没到复习时间的也可以提交[XVP]

urnote's People

Contributors

toaco avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

zdhgamer

urnote's Issues

用户可以在移动端复习笔记

最理想的方案是提供urnote的移动版+同步功能。

但这样做的话任务量较大,个人的时间也不允许,所以最终想出了如下的方式来暂时解决移动端的复习。

使用已有的云盘同步PC上的笔记到云服务器以及手机上,在手机上复习之后,再同步到PC上使用urnote程序处理复习结果。

这样做的好处是实现简单,坏处是必须要依赖PC才能真正的完成一次复习。由于个人几乎每天都会使用PC,所以问题不是很大=。=

为了方便使用这种方式复习,需要对程序增加几项特性,包括:

  • 导出到TASK目录的复习文件可以是真正的文件而不是链接(因为很多云盘同步不能同步链接)
  • 导出到TASK目录的文件可能不能按照原始文件的文件夹层次来组织,层次太深不方便查看
  • 到处的文件可能需要减少数量,一方面可以让用户选择复习的文件夹来减少文件数,另一方面可以合并多个文件内容到一个文件中
  • 文件的内容可能需要精简,目前的实现到处文件所有内容,应当支持导出的时候可以选择只到处QA部分。这样还需要额外定义A的格式,有下面几种考虑:
    • 规定Q后面的多少行为A
    • 规定Q后面的某个符号代表A的结尾
    • 用户自定义Q后面的A的正则表达式(可能会实现这种)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.