Skip to content

Commit

Permalink
use custom docs/API.md instead of broken README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Christopher Hiller <boneskull@boneskull.com>
  • Loading branch information
boneskull committed May 17, 2018
1 parent dd45d0a commit 933baa7
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 31 deletions.
20 changes: 20 additions & 0 deletions docs/API.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Mocha's API Documentation

* * *

Congratulations! You've found Mocha's API documentation. These docs are for developers who wish to:

- Create an extension for Mocha, or
- Develop Mocha itself, or
- Do something else fancy with Mocha

Otherwise, **you probably want the [main documentation](https://mochajs.org)**.

## Other Links

- **[Main Documentation](https://mochajs.org)**
- **[Release Notes / History / Changes](https://github.com/mochajs/mocha/blob/master/CHANGELOG.md)**
- [Code of Conduct](https://github.com/mochajs/mocha/blob/master/.github/CODE_OF_CONDUCT.md)
- [Gitter Chatroom](https://gitter.im/mochajs/mocha) (ask questions here!)
- [Google Group](https://groups.google.com/group/mochajs)
- [Issue Tracker](https://github.com/mochajs/mocha/issues)
1 change: 1 addition & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ exclude:
- README.md
- .*
- LICENSE*
- API.md
repository: mochajs/mocha
source: docs

59 changes: 28 additions & 31 deletions jsdoc.conf.json
Original file line number Diff line number Diff line change
@@ -1,35 +1,32 @@
{
"tags": {
"allowUnknownTags": true
},
"source": {
"include": [
"lib/",
"./README.md"
]
},
"plugins": ["plugins/markdown"],
"opts": {
"encoding": "utf8",
"tags": {
"allowUnknownTags": true
},
"source": {
"include": ["lib/", "./docs/API.md"]
},
"plugins": ["plugins/markdown"],
"opts": {
"encoding": "utf8",
"template": "node_modules/@mocha/docdash",
"destination": "docs/api",
"recurse": true,
"verbose": true
},
"markdown": {
"parser": "gfm",
"hardwrap": true
},
"templates": {
"cleverLinks": false,
"monospaceLinks": false,
"default": {
"outputSourceFiles": true,
"includeDate": false
}
},
"mocha-docdash": {
"static": false,
"sort": true
"destination": "docs/api",
"recurse": true,
"verbose": true
},
"markdown": {
"parser": "gfm",
"hardwrap": true
},
"templates": {
"cleverLinks": false,
"monospaceLinks": false,
"default": {
"outputSourceFiles": true,
"includeDate": false
}
},
"mocha-docdash": {
"static": false,
"sort": true
}
}

0 comments on commit 933baa7

Please sign in to comment.