-
-
Notifications
You must be signed in to change notification settings - Fork 3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
use custom docs/API.md instead of broken README.md
Signed-off-by: Christopher Hiller <boneskull@boneskull.com>
- Loading branch information
Showing
3 changed files
with
49 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,6 +3,7 @@ exclude: | |
- README.md | ||
- .* | ||
- LICENSE* | ||
- API.md | ||
repository: mochajs/mocha | ||
source: docs | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
} | ||
} |