diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c6ab637 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,9 @@ +## Generating documentation + +Documentation is automatically generated via GitHub action ["fundoc"](.github/workflows/fundoc.yml) and published to GitHub Pages. You don't need to commit it when working on the repo. + +To generate documentation locally for test purposes you'll need to [install `fundoc`](https://github.com/CSSSR/fundoc#installation) first. Then you can run `fundoc` or `yarn build` in the project root. + +To automatically generate documentation on files change consider configuring file watcher in your IDE. Example configuration for WebStorm: + +![](https://s.csssr.ru/U07B23NE8/2021-04-20-12-39-40-9zc8j.jpg) diff --git a/README.md b/README.md index 912a72d..f7d86c0 100644 --- a/README.md +++ b/README.md @@ -104,3 +104,5 @@ module.exports = { ``` You can find more recommendations for manual configuration [here](https://csssr.github.io/linters/recommendations.html). + +## [Contributing](CONTRIBUTING.md) diff --git a/book.toml b/book.toml index 959df3e..a63545c 100644 --- a/book.toml +++ b/book.toml @@ -3,7 +3,7 @@ authors = [] language = "en" multilingual = false src = "./docs_src" -title = "CSSSR Linting" +title = "CSSSR Linters" [build] build-dir = "./docs" diff --git a/fundoc.json b/fundoc.json index 0ffbc6a..ed00078 100644 --- a/fundoc.json +++ b/fundoc.json @@ -9,6 +9,6 @@ "comment_prefix": "*", "comment_end_string": "*/", "mdbook": true, - "book_name": "CSSSR Linting", + "book_name": "CSSSR Linters", "book_build_dir": "./docs" }