uesteibarhyperdocs
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 reactIf the documentation is found, it will open it right away. If it's not, it will open a duckduckgo search instead (currently broken due to duckduckgo not allowing to be shown in an iframe anymore #14).
Running 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][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][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][conventional-changelog-standard].
- when you're ready to release a new version:
git checkout master; git pull origin master- run
npm run release
Helpers/Tools
- Changelog
- Code of conduct
- commitizen: 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.
- conventional-changelog-standard
- cz-conventional-changelog
- standard-version