WikiTerm-rs

此项目旨在创建一个终端应用程序（主要使用 vim 动作），允许您快速搜索维基百科的离线副本。

安装/设置

您可以通过 crates.io 进行安装

cargo install wiki_reader
# To start (Please set the config as below first)
wiki_reader

此应用程序期望在 ~/.config/wikiterm/config.json 存在一个配置文件

以下格式

{
    "wiki_bzip_path": "~/Documents/wiki/simple/base.bz2",
    "meta_directory": "~/Documents/wiki/simple/meta",
}

如果不存在，将根据上述配置创建 meta_directory。

wiki_bzip_path 是下载的 bzip2 (xml) 归档文件的路径。它期望这是一个多流版本。

https://meta.wikimedia.org/wiki/Data_dump_torrents

请注意，更大的导出将需要更长的时间来索引（但只需做一次）。

meta_directory 是您希望任何索引/由本项目生成的文件存放的地方。

使用方法

您应该可以使用 (目前是 vim 绑定的子集) 进行导航

j, k
up, down

:q to quit or Ctrl-c

Esc to exit back to normal mode
/ to search

以下是一些基本绑定，要获取其余的，请使用 ?。

局限性/改进空间

这目前还在进行中，因此许多功能将缺失/不完美，例如

• 搜索现在并不太出色，需要改进
• 目前不解析维基文本，因此输出没有格式化
• 支持本地图片，可能还允许您为远程设置标志。
• 需要改进用于索引的序列化，大型的 json 文件可能导致启动变慢。

由于这仍然相对较新，因此在过程中可能会进行很多破坏性更改，例如更改配置路径或保存的文件名（这将需要重新索引）。

贡献

如果您想进行重大更改，请首先打开一个问题，以避免任何浪费时间。这是我第一个操作系统项目，也是我第一个真正的 Rust 项目，我正在用它来学习 Rust，因此这可能不是完全符合 Rust 风格的 Rust，这里可能有一些捷径。