The sequelize documentation is written in a combination of markdown (articles and example based documentation) and [JSDoc](http://usejsdoc.org)(API reference generated from source code comments).
The sequelize documentation is divided in two parts:
All documentation is located in the `docs` folder.
* Tutorials, guides, and example based documentation are written in Markdown
* The API reference is generated automatically from source code comments with [ESDoc](http://esdoc.org)(which uses [JSDoc](http://usejsdoc.org) syntax).
The documentation is rendered using [esdoc](http://esdoc.org) and continuously deployed to [Surge](http://surge.sh). ESdoc generates static HTML from the code comments.
The whole documentation is rendered using ESDoc and continuously deployed to [Surge](http://surge.sh). The output is produced in the `esdoc` folder.
All pages in the documentation are defined in the `manual` section of `.esdoc.json`. Each page is given as a separate line:
The tutorials, written in markdown, are located in the `docs` folder. ESDoc is configured to find them in the `"manual"` field of `.esdoc.json`.
To view the docs locally run `npm run docs` and open the generated HTML in your favorite browser.
To generate the docs locally, run `npm run docs` and open the generated `esdoc/index.html` in your favorite browser.
## Articles and example based docs
## Articles and example based docs
Write markdown, and have fun :)
Write markdown, and have fun :)
## API docs
## API docs
Change the source-code, and rerun `npm run docs` to see your changes.
Change the source code documentation comments, using JSDoc syntax, and rerun `npm run docs` to see your changes.
@@ -132,6 +132,10 @@ Then push and send your pull request. Happy hacking and thank you for contributi
...
@@ -132,6 +132,10 @@ Then push and send your pull request. Happy hacking and thank you for contributi
Have a look at our [.eslintrc.json](https://github.com/sequelize/sequelize/blob/master/.eslintrc.json) file for the specifics. As part of the test process, all files will be linted, and your PR will **not** be accepted if it does not pass linting.
Have a look at our [.eslintrc.json](https://github.com/sequelize/sequelize/blob/master/.eslintrc.json) file for the specifics. As part of the test process, all files will be linted, and your PR will **not** be accepted if it does not pass linting.
# Contributing to the documentation
For contribution guidelines for the documentation, see [CONTRIBUTING.DOCS.md](https://github.com/sequelize/sequelize/blob/master/CONTRIBUTING.DOCS.md).
