#api-server #markdown #document #index #schema #openapi #search

app smark

该工具提供API,从文件中获取Markdown文档

1 个不稳定版本

0.1.9 2022年4月17日
0.1.6 2022年4月9日

#17#documents

MIT 许可证

140KB
3K SLoC

smark

codecov API Documetation

smark 是一个将Markdown作为API服务器提供服务的工具。

该工具基于 tantivy(Rust中的一个全文搜索引擎)和 lindera(Rust中的一个形态学分析库)提供API,用于从文件中获取Markdown文档。

有关详细信息,请参阅 API 文档smark 还提供 openapi模式

安装

您可以从发布页面获取发布二进制文件或使用以下命令安装:cargo install smark

准备帖子

您可以使用 template 子命令创建带有所需元数据的模板Markdown。

smark template

# ---
# uuid: db71b71a-c7f2-47c4-ab87-81bd1bb6d58a
# title: ""
# description: ""
# lang: ja
# category: ""
# ---

准备索引

您需要准备索引来注册您的Markdown帖子。请指定输入Markdown目录和输出索引目录。

smark 识别 posts/**/*.md 文件。

smark prep --index-dir index --input posts

运行服务器

您已完成所有步骤!让我们运行服务器!

smark run --index-dir index --static-dir images

从源代码

您可以使用交叉编译。

git clone https://github.com/illumination-k/smark.git
cross build --target x86_64-unknown-linux-musl --release
chmod 777 target/x86_64-unknown-linux-musl/release/smark

依赖项

~36–50MB
~851K SLoC