This repository has been archived by the owner on Dec 12, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #520 from stormpath/jsdoc
New JsDocs
- Loading branch information
Showing
168 changed files
with
17,819 additions
and
11,275 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 |
---|---|---|
@@ -1,5 +1,6 @@ | ||
.coveralls.yml | ||
.env | ||
apidocs | ||
docs | ||
samples | ||
test |
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,37 @@ | ||
# Contribution Guide | ||
|
||
We love pull requests! | ||
|
||
Here are a few things you'll need to know if you want to make a contribution to | ||
this library. | ||
|
||
### Submitting Pull Requests | ||
|
||
Pull requests are welcome, and will be reviewed as soon as possible. Please | ||
ensure that the tests are passing and that new features have test coverage. When | ||
you submit the PR the tests will fail on Travis, even if they are working locally. | ||
This is because we use encrypted environment variables on Travis, and this will | ||
fail for PRs from forks. This is okay, we will pull down your branch and run | ||
the tests locally for confirmation. | ||
|
||
### Documentation | ||
|
||
This library uses JsDoc for documentation. To build the docs: | ||
|
||
``` | ||
npm run docs | ||
``` | ||
|
||
The output will be placed in `./apidocs`. If you are going to do a lot of work | ||
on the documentation, I suggest the development script, it will rebuild the | ||
files when you make changes, and open a web server with the documentation: | ||
|
||
``` | ||
./docs/develop.sh | ||
``` | ||
|
||
If you need to modify the theme or template, you can find that in `docs/template`. | ||
This template was cloned from the [Docstrap][] project. | ||
|
||
[Docstrap]: https://github.com/docstrap/docstrap | ||
|
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
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,6 @@ | ||
#!/bin/bash | ||
|
||
npm run docs | ||
./node_modules/httpster/bin/httpster -d ./apidocs & | ||
open http://localhost:3333 | ||
./node_modules/nodemon/bin/nodemon.js -w ./docs/JSDOC.md -w lib/ -x "npm run docs" -e js |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.