QuickMD

本项目是一个简单的工具，解决了一个简单的问题：我想预览 markdown 文件，就像它们在 Github 上显示的那样，这样我就可以在推送 README 之前知道它们是否格式良好。最终效果如下

这是一个 Rust 应用，它启动一个 GtkWebkit 窗口，渲染给定 markdown 文件的编译后的 HTML。它监视该文件是否有任何更改，并重新加载。它使用的是直接从 Github 的 markdown 样式表复制而来的样式表。

注意：我不知道我是否被允许使用 Github 的样式表。相关的文件位于 res/style/github.css 中，如果被告知我不应该使用它，我会将其从 git 历史中删除。

安装

从发布二进制文件

从 v0.4.1 版本开始，您应该能够在每个版本中找到一个编译好的 64 位 Linux 二进制文件。您可以将其放入您的 $PATH 中，并启动它，前提是您在系统上安装了 GTK3 和 Webkit2Gtk。在 Arch Linux 上，您可以像这样安装它们

# pacman -S gtk3 webkit2gtk

从源代码安装

您需要安装 Rust 和 cargo 工具。最简单的方法是通过 rustup.rs。

您还需要安装系统上的 GTK3 和 Webkit2Gtk 开发 文件。Gtk-rs 安装页面 可能是一个良好的起点。

之后，您可以使用以下命令从 crates.io 构建和安装应用程序

cargo install quickmd

请确保 ~/.cargo/bin 在您的 PATH 中，这样您就可以调用 quickmd 可执行文件。

使用方法

运行应用程序非常简单

quickmd <markdown-file>

按 CTRL+Q 将关闭窗口。使用 --help 运行它应提供更多有关可用选项的信息。以下是我看到的结果

quickmd 0.6.0
A simple self-contained markdown previewer.

Code highlighting via highlight.js version 9.18.1

Edit configuration in: /home/andrew/.config/quickmd/config.yaml
Add custom CSS in:     /home/andrew/.config/quickmd/custom.css

USAGE:
    quickmd [FLAGS] [OPTIONS] [input-file.md]

FLAGS:
    -d, --debug
            Activates debug logging

    -h, --help
            Prints help information

        --install-default-config
            Creates a configuration file for later editing if one doesn't exist. Exits when done

    -V, --version
            Prints version information

        --no-watch
            Disables watching file for changes


OPTIONS:
        --output <directory>
            Builds output HTML and other assets in the given directory instead of in a tempdir. Will be created if it
            doesn't exist. Not deleted on application exit

ARGS:
    <input-file.md>
            Markdown file to render. Use "-" to read markdown from STDIN (implies --no-watch). If not provided, the app
            will launch a file picker

功能

• 类似 Github 的渲染，但并不保证完全相同。依赖于 whatever pulldown-cmark 提供，对我来说已经足够好。

• 文件写入时快速且无缝的预览更新。

• 通过 highlight.js 进行代码高亮。目前，相关的javascript是通过CDN包含的，不幸的是，这意味着在没有互联网连接的情况下无法工作。

• 能够渲染 STDIN，这允许部分渲染目标markdown。尝试将 这段 Vimscript 放入你的 ~/.vim/ftplugin/markdown.vim 中，选择几行并按 !。

• 使用 Vi-like 键绑定滚动，如果配置了，按 e 启动编辑器。

• 可自定义的键绑定。查看API文档或尝试 --install-default-config 以获取带有示例的注释配置。

配置

你可以通过在应用程序的配置目录中写入名为 "custom.css" 的文件来更改预览HTML的CSS。在linux机器上，它将是： ~/.config/quickmd/。

你还可以在配置文件中更改一些配置选项。用 --install-default-config 运行 quickmd 来创建包含所有默认值和注释的文件。

运行 --help 来查看配置文件将在你的系统中的位置，或在界面中按 F1。

使用的内置CSS存储在 /res/style，默认配置在 /res/default_config.yaml