#markdown #list #ui

bin+lib lister-cli

Lister:导航 Markdown 列表

4 个版本

0.1.3 2024年2月15日
0.1.2 2024年2月15日
0.1.1 2024年1月16日
0.1.0 2024年1月16日

文本处理 中排名第 447

每月下载量 26

MIT 许可证

200KB
570

Lister:导航事物的 Markdown 列表

Lister 是一个小工具,帮助你导航大的 Markdown 列表。它不处理完整的 Markdown 格式,只处理其显示的子集。Lister 允许你交互式地折叠和导航树,并很快将能够以非常类似的方式修改列表并将其写回,这样 Markdown 文件本身就可以用作数据库。

安装

cargo install lister-cli

这将将在 lister 二进制文件安装到 $CARGO_HOME/bin

用法

输入 lister <filename>lister --help 查看选项。在 UI 中按 ? 获取帮助,并按 q 退出到 shell。

格式

以下列出了格式的规则。

支持复选框,并将最终与保存功能一起,允许独立于编辑器的任务管理系统。我们还有大量的工作要做,但它们有望成为强大的功能。

如果你需要格式示例,请 查看这里。现在

  • 标题以 # 开头:它们必须在文件顶部呈现,在所有其他非空白内容之前。文件只能有一个标题。
  • 每个列表项以 -* 开头,可能包含一个可选的 [ ],其中用 x 代替空格来表示已勾选的项目。随后,任何文本都是项目的标题,并可能跨越多行,直到遇到下一个列表项或文件末尾。
  • 列表嵌套由空格缩进控制,所有项目必须与父项的 - 标记保持等距,除此之外,你可以自由地缩进。制表符不会展开为空格,并且只被视为一个字符,如果与正常空格字符混合,可能会导致痛苦的结果。
    • 树的每一层嵌套在所有行上都有等效的空白。即使只缩进或缩进一个空格,也会产生额外的意外嵌套级别。
  • 使用以下键来导航工具
    • ? 用于交互式帮助(再次按 ? 或按 q 退出帮助菜单)
    • q 退出程序
    • j 或向下箭头向下移动
    • k 或向上箭头向上移动
    • 按 Enter 或空格展开子树

作者

Erik Hollensbe [email protected]

许可证

MIT

依赖项

~9–22MB
~254K SLoC