mirror of https://github.com/vapor/docs.git
30 lines
536 B
Markdown
30 lines
536 B
Markdown
# Contributing to Vapor Docs
|
|
|
|
Found a mistake or want to add something? Fork the documentation, fix it, and submit a pull request.
|
|
|
|
We'll merge it as soon as we can.
|
|
|
|
Thanks!
|
|
|
|
## Developing
|
|
|
|
### 1.0
|
|
|
|
Install `couscous` through Composer and run `couscous preview`
|
|
|
|
### 2.0 and 3.0
|
|
|
|
Install MkDocs and MkDocs Material theme.
|
|
|
|
```sh
|
|
pip install mkdocs
|
|
pip install mkdocs-material
|
|
```
|
|
|
|
Run with `mkdocs serve`
|
|
|
|
### Maintainers
|
|
- @0xtim
|
|
- @mcdappdev
|
|
|
|
See https://github.com/vapor/vapor/blob/master/Docs/maintainers.md for more information. |