Skip to content

Commit

Permalink
Add a section about working on the manual
Browse files Browse the repository at this point in the history
  • Loading branch information
bbatsov committed Apr 1, 2016
1 parent b4f5ce9 commit a216e34
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion doc/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,34 @@ guidelines](https://github.com/clojure-emacs/cider/blob/master/.github/CONTRIBUT

### Documentation

Consider improving and extending the [community wiki](https://github.com/clojure-emacs/cider/wiki).
Good documentation is just as important as good code.

Consider improving and extending the
this manual and the
[community wiki](https://github.com/clojure-emacs/cider/wiki).

#### Working on the Manual

The manual is generated from the markdown files in the
[doc](https://github.com/clojure-emacs/cider/tree/master/doc) folder of CIDER's
GitHub repo and is published to [Read the Docs](readthedocs.org). The
[MkDocs](http://www.mkdocs.org/) tool is used to convert the markdown sources to
HTML.

To make changes to the manual you simply have to change the files under
`doc`. The manual will be regenerated automatically when changes to those files
are merged in `master` (or the latest stable branch).

You can install `MkDocs` locally and use the command `mkdocs serve` to see the
result of changes you make to the manual locally:

```
cd path/to/cider/repo
mkdocs serve
```

If you want to make changes to the manual's page structure you'll have to edit
[mkdocs.yml](https://github.com/clojure-emacs/cider/blob/master/mkdocs.yml).

### Donations

Expand Down

0 comments on commit a216e34

Please sign in to comment.