#notes #syntax-highlighting #cli #productivity #minimalist

app mn

CLI 应用程序,用于记住那些让你忘记的小事

11 个版本

0.2.1 2019年1月25日
0.2.0 2019年1月25日
0.1.8 2019年1月24日

#86#notes

每月下载36

MITLGPL-3.0-or-later

470KB
844

记忆法

记忆法是一个 CLI 应用程序,用于记住那些让你忘记的小事。

我经常忘记事情——不是什么大事,只是那些我很少使用而无法记住的小 Unix 命令,一些可能让我忘记的小细节,诸如此类。

我过去常常在主目录中保存一个 notes 文本文件,然后运行 cat ~/notes 来唤醒我的记忆。但后来我决定肯定有更好——更美观——的方法。但最重要的是,一种可以保留输入 cat ~/notes 的简洁性。

因此,记忆法 诞生了。使用 mn 命令,可以快速在终端打印出语法高亮的记忆法。下面是它的使用示例:

Mnemonic in use

安装

目前,您有两种安装选项,都需要 Rust 支持。

  • 使用 cargo install mn 安装(仅安装可执行文件本身)
  • 克隆仓库,进入目录,并运行 make install(安装可执行文件和 Zsh 补全(man 页面和为其他 shell 的补全即将推出))

将来,将支持更多安装说明(包括通过传统的包管理器)。

用法

运行 mn --help 以获取完整的使用详情。基本命令包括 mn <MNEMONIC>,显示之前创建的助记符;mn list,列出所有现有助记符;mn add <MNEMONIC>,使用您的 $EDITOR 创建一个新的助记符;以及 mn edit <MNEMONIC>,编辑现有的助记符。

这些子命令也接受各种选项。例如,您还可以使用 mn add <MNEMONIC> --push "<TEXT>" 将文本推送到助记符而不打开它,或者使用 mn show <MNEMONIC> --syntax "yaml" 以显示具有 YAML 语法高亮的助记符。

请参阅 help 命令以获取完整详情。

语法高亮

助记符会将所有输出高亮显示为 Markdown。如果您希望部分文本以不同语言高亮显示,可以使用 GitHub 风格的代码围栏。例如,

```rust
fn main() {
    println!("Hello, world!");
}

```

将显示类似于以下语法高亮的输出

fn main() {
    println!("Hello, world!");
}

语法高亮主题可以通过与 Bat 中使用的相同主题进行用户配置,而 Bat 是该项目的主要灵感来源。

依赖关系

~23–34MB
~561K SLoC