(UNSUPPORTED) Get docs right in your hyper terminal.
Get docs right in your hyper terminal.
Asuming you alredy use hyper and hpm] (If you don’t, please, go check them out)
hpm install hyperdocs
else, add it to your ~/.hyper.js file
plugins: ['hyperdocs']
Enjoy =)
hyperdocs {language or framework}
for example:
hyperdocs react
If 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).
Go to your hyper plugins folder
cd ~/.hyper_plugins/local
Clone the repository
git clone --depth=1 git@github.com:uesteibar/hyperdocs.git
Install dependencies
cd hyperdocsnpm install
Add to your .hyper.js file
localPlugins: ['hyperdocs']
Every time you make a change, you have to
npm run build
and refresh your hyper terminal.
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):
master branch, select the Rebase and Merge option.git checkout master; git pull origin masternpm run release