@accessibility-tools/ci 中文文档教程
A11Y CI
CI 工具允许您针对指定的 url 运行自动化的可访问性测试。 它会静默运行，直到爬行完成，除非您指定它在爬行之上执行其他功能，例如，您可以要求爬行器在完成时将结果写入文件。
Getting Started
Prerequisites
在开始在本地设置项目之前，我假设您的计算机上已经安装了以下内容：
Installing
通过运行安装 CLI：
npm install @accessibility-tools/ci -g
安装后，您可以使用 aci 命令运行 cli。 要获得可用配置选项的列表，您可以运行 aci --help。
Running the application
要运行该应用程序，只需运行：
aci [options]
See all valid flags that you can pass
aci --help
可以在 parse-args 帮助程序脚本 中找到标志配置。
Example usage
Scan a whole site
aci https://example.com
或者
aci -s https://example.com
Limit the amount of pages scanned
aci https://example.com -l 1
Scan a whole site and display results in the terminal
aci https://example.com -d
Ignore fragment links and query params
aci https://example.com -i -q
Built With
Contributing
请阅读贡献指南，了解我们的行为准则以及向我们提交拉取请求的流程的详细信息。
当您准备好开始贡献时，您可以通过运行以下命令拉取存储库：
git clone git@github.com:accessibility-tools/CI.git
进入目录并安装依赖项
cd a11y-ci
npm install
现在您应该可以开始了！
Versioning
对于这个项目，我们使用语义版本控制。
License
该项目根据 MIT 许可证获得许可 - 有关详细信息，请参阅许可证文件。
Direct and Indirect contributors
A11Y CI
The CI tool allows you to run automated accessibility tests against a specified url. It will run silently until crawling is complete unless you specify it to do another function on top of the crawling, for example, you can ask the crawler to write the results to a file on completion.
Getting Started
Prerequisites
Before getting started with setting the project up locally, I assume the following are already installed on your computer:
Installing
Install the CLI by running:
npm install @accessibility-tools/ci -g
Once installed you can run the cli using the aci command. For a list of available configuration options, you can run aci --help.
Running the application
To run the application, simply run:
aci [options]
See all valid flags that you can pass
aci --help
Flag configurations can be found in the parse-args helper script.
Example usage
Scan a whole site
aci https://example.com
Or
aci -s https://example.com
Limit the amount of pages scanned
aci https://example.com -l 1
Scan a whole site and display results in the terminal
aci https://example.com -d
Ignore fragment links and query params
aci https://example.com -i -q
Built With
Contributing
Please read Contribution guidelines for details on our code of conduct, and the process for submitting pull requests to us.
When you are ready to begin contributing, you can pull the repository by running:
git clone git@github.com:accessibility-tools/CI.git
Move into the directory and install the dependencies
cd a11y-ci
npm install
Now you should be good to go!
Versioning
For this project we use Semantic Versioning.
License
This project is licensed under the MIT License - see the Licence file for details.
