https://github.com/test-prof/docs-zh-cn
Chinese documentation
https://github.com/test-prof/docs-zh-cn
Last synced: 20 days ago
JSON representation
Chinese documentation
- Host: GitHub
- URL: https://github.com/test-prof/docs-zh-cn
- Owner: test-prof
- Created: 2020-07-22T14:54:15.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-23T19:51:47.000Z (12 months ago)
- Last Synced: 2025-04-23T20:36:58.342Z (12 months ago)
- Size: 136 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TestProf docs in Chinese
This repo contains (will contain) Chinese documentation for [TestProf][].
The docs will be available at the main [documentation website](https://test-prof.evilmartians.io/).
[Translations guide](https://github.com/test-prof/docs/blob/master/TRANSLATIONS.md).
## Linters
We try to keep our documentation both correct and _stylish_ using the following tools:
- [mdl](https://github.com/markdownlint/markdownlint)—Markdown linter, Ruby edition.
- [liche](https://github.com/raviqqe/liche)—links linter.
- [forspell](https://github.com/kkuprikov/forspell)—spelling checker.
- RuboCop with [rubocop-md](https://github.com/rubocop-hq/rubocop-md) and [standard](https://github.com/testdouble/standard)—Ruby code snippets style checking.
To run these tools locally we use [Lefthook](https://github.com/Arkweid/lefthook) (runs linters automatically for every commit).
To sum up:
- Install `mdl`:
```sh
gem install mdl
```
- Install `liche`:
```sh
go get -u github.com/raviqqe/liche
```
- Install Hunspell and Forspell:
```sh
# for MacOS (for other OS see Forspell documentation)
brew install hunspell
gem install forspell
```
- Install StandardRB and `rubocop-md`:
```sh
gem install standard
gem install rubocop-md
```
- Install `lefthook`:
```sh
# for MacOS (for other OS see Lefthook documentation)
brew install lefthook
```
- Initialize `lefthook`:
```sh
lefthook install
```
Or you can skip all of these and rely on our CI, which can do all the checks for you!
[TestProf]: https://github.com/test-prof/test-prof