Package Exports
- hyperdocs
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (hyperdocs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
hyperdocs
Get docs right in your hyper terminal.
Install
Asuming you alredy use hyper and hpm] (If you don't, please, go check them out)
hpm install hyperdocselse, add it to your ~/.hyper.js file
plugins: ['hyperdocs']Enjoy =)
Usage
hyperdocs {language or framework}for example:
hyperdocs reactRunning locally
Go to your hyper plugins folder
cd ~/.hyper_plugins/localClone the repository
git clone --depth=1 git@github.com:uesteibar/hyperdocs.gitInstall dependencies
cd hyperdocs
npm installAdd to your .hyper.js file
localPlugins: ['hyperdocs']Every time you make a change, you have to
npm run buildand refresh your hyper terminal.
Contributing
Pull request are welcome to add more docs =) Just add the urls to src/constants/urls.js.
The project uses standard-version to update the CHANGELOG with each commit message and upgrade the package version. For that reason every contribution should have a title and body that follows the conventional-changelog-standard conventions.
So this is a step by step guide to contributing to the project (mostly extracted from the standard-version docs):
- when you land commits on your
masterbranch, select the Rebase and Merge option. - add a title and body that follows the conventional-changelog-standard conventions.
- when you're ready to release a new version:
git checkout master; git pull origin master- run
npm run release
Helpers/Tools
- commitzen: A cli that will prompt the author to fill out any required commit fields at commit time. For this project we would use the cz-conventional-changelog adapter.