Starter/typescript-starter
1
0
Fork 0
mirror of synced 2025-11-08 12:57:47 +00:00
Code Issues Releases Wiki Activity

feat(gh-pages): add package script for publishing docs to gh-pages

Browse Source 
Closes #14
This commit is contained in:
Jason Dreyzehner
2017-03-01 18:56:43 -05:00
parent 0d8665fd96
commit 1dfe83059f
3 changed files with 76 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -81,10 +81,18 @@ The src folder is analyzed and documentation is automatically generated using [t
```bash
yarn docs
```
This command generates API documentation for your library in HTML format.
This command generates API documentation for your library in HTML format and opens it in a browser.
Since types are tracked by Typescript, there's no need to indicate types in JSDoc format. For more information, see the [typedoc documentation](http://typedoc.org/guides/doccomments/).
To generate and publish your documentation to [GitHub Pages](https://pages.github.com/) use the following command:
```bash
yarn docs:publish
```
Once published, your documentation should be available at the proper GitHub Pages URL for your repo. See [this repo's GitHub Pages](https://bitjson.github.io/typescript-starter/) for an example.
<p align="center">
<img height="500" alt="typedoc documentation example" src="https://cloud.githubusercontent.com/assets/904007/22909419/085b9e38-f222-11e6-996e-c7a86390478c.png">
</p>