README

文档验证工具，确保没有任何内容被认为是简单或容易的。

在您的CI流程中运行 Simple 以确保您不会发布任何贬低或对学习者无帮助的文档。在 Simple 发现任何问题词汇的地方，可能是提供更详细文档的完美案例。

它就像是您文档的一个单元测试。

用法

要使用simple，请在命令行中运行它，提供文档文件所在的目录。示例

要生成默认配置文件，运行 init

simple init

然后您可以直接运行它

simple

或指定特定目录

simple -f./docs/

要获取完整的选项和标志列表，运行帮助命令

simple help

在CI中

在CI中，建议这样运行

simple --no-color --no-progress-bar --report-file=report.junit.xml

这将强制生成junit报告，供您的CI报告系统使用。

安装

Simple可以作为可执行PHAR安装，或者作为composer依赖项安装。

或者，它可以用在CI构建或本地使用docker。

Docker

docker镜像是：marisa50/simple。

在您的文档上运行simple

docker run --rm --interactive --tty -v "$(pwd):/app" -w="/app" ghcr.io/m50/simple:latest

Phar

wget -O simple.phar $(curl -s https://api.github.com/repos/m50/simple/releases/latest | jq -aM .assets[0].browser_download_url | tr -d '"')
chmod 755 simple.phar
mv simple.phar /usr/local/bin/simple

Composer

composer global require m50/simple

m50 / simple

维护者

详细信息

README

用法

在CI中

安装

Docker

Phar

Composer