一个简单的工具,用于从终端记录笔记(并在设备之间同步)。
![石板状态](https://user-images.githubusercontent.com/634827/51380042-13144400-1b11-11e9-846f-114ee282c29c.png)
生成降价任务列表.
目录
安装
您可以使用安装堆栈(需要堆栈>=1.6)。
$stack安装板
基本用法
$slate--帮助石板&记笔记的工具。用法:石板命令板岩可用选项:-h、 --help显示此帮助文本可用命令:添加添加注释。done在给定音符ID时将音符标记为done,显示另外做了笔记。todo在给定注释ID时将注释标记为todo,显示待办事项另有说明。在给定注释ID时切换注释的高亮显示,显示标记为正在执行其他操作的注释。删除删除注释。display显示石板。重命名重命名石板。擦擦石板。status显示石板的状态。sync同步每个板岩。$slate添加“我的*第一个*注释”$slate添加“新便笺!”$平板显示器0-我的第一注意。1-新笔记!$slate已完成0$平板显示器0-我的第一注意。1-新笔记!$slate display--only=todo#或仅slate todo1-新笔记!$石板状态1个完成,1个待办事项(共2个)。50%·1完成·1待办事项-同步✔▮▮▮▮▮▮▮▮▮▮▮▮▮▮▮▯▯▯▯▯▯▯▯▯▯▯▯▯▯▯$slate添加“假便笺”$平板显示器0-我的第一注意。1-新笔记!2-假钞$slate删除2$平板显示器0-我的第一注意。1-新笔记!$slate擦除--only=todo$平板显示器0-我的第一注意。$slate待办事项0$平板显示器0-我的第一注意。
列表存储在~/.config/slate/
它们的默认名称是当前目录的名称。您可以使用任何其他名称--姓名
选项或通过添加.石板
包含要使用的名称的文件。
配置
可以在中设置以下配置选项~/.config/slate/config.toml
(您必须创建此文件)。
你可以结账配置示例.toml配置示例。
回调
您必须在[回叫]
表:
[回拨]键1=值1键2=值2...
同步
你可以使用石板同步
同步你的石板。此命令没有默认配置,因此要使其正常工作,您必须添加自己的同步命令,例如:
sync=“git add.&&git commit-m‘更新slates’;git pull--rebase origin master&&git push origin master”
这将在中分阶段提交每个更新(&C)~/.config/slate/
,更新您的本地副本并将您的更新推送到起源
远程。
地位
默认情况下,石板状态
仅按状态显示注释数。可以在中添加命令地位
用于检查石板是否同步的键,例如:
status=“git-diff--退出代码$SLATE”
在哪里?$石板
将设置为~/.config/slate/<slate-name>.md
。如果石板不同步,则命令必须返回非零退出代码,如果已同步,则命令必须返回零。
自动完成
您可以使用以下命令为shell生成完成脚本:
- 猛击:
slate—bash-completion-script$(哪个slate)
- 兹许:
slate—zsh完成脚本$(哪个slate)
- 鱼类:
slate—fish-completion-script(哪个slate)