https://github.com/test-prof/docs-ru
Документация на русском языке
https://github.com/test-prof/docs-ru
Last synced: 20 days ago
JSON representation
Документация на русском языке
- Host: GitHub
- URL: https://github.com/test-prof/docs-ru
- Owner: test-prof
- Created: 2020-07-22T14:11:35.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-29T22:32:45.000Z (almost 2 years ago)
- Last Synced: 2025-03-04T20:42:55.824Z (about 1 year ago)
- Size: 814 KB
- Stars: 0
- Watchers: 4
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TestProf по-русски
Здесь когда-нибудь будет русскоязычная документация для [TestProf][].
Посмотреть её можно будет [на основном сайте](https://test-prof.evilmartians.io/).
[Инструкция по локализации](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)—spell-checker for English.
- [yaspeller](https://github.com/hcodes/yaspeller)—spell-checker for Russian.
- 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 [yaspeller](https://github.com/hcodes/yaspeller):
```sh
npm install -g yaspeller
```
- 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