Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uesteibar/hyperdocs
(UNSUPPORTED) Get docs right in your hyper terminal.
https://github.com/uesteibar/hyperdocs
deprecated docsearch documentation hyper hyper-app hyper-plugin hyperterm
Last synced: 3 months ago
JSON representation
(UNSUPPORTED) Get docs right in your hyper terminal.
- Host: GitHub
- URL: https://github.com/uesteibar/hyperdocs
- Owner: uesteibar
- License: other
- Created: 2017-04-09T15:45:05.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-01-11T22:54:21.000Z (about 6 years ago)
- Last Synced: 2024-10-12T13:10:45.341Z (3 months ago)
- Topics: deprecated, docsearch, documentation, hyper, hyper-app, hyper-plugin, hyperterm
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/hyperdocs
- Size: 28.3 KB
- Stars: 13
- Watchers: 2
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# hyperdocs
[]()
[](https://badge.fury.io/js/hyperdocs)
[](https://codeclimate.com/github/uesteibar/hyperdocs)
[]()
Get docs right in your hyper terminal.
- [Install](#install)
- [Usage](#usage)
- [Running Locally](#running-locally)
- [Contributing](#contributing)
- [Helpers/Tools](#helperstools)
- [Maintainers](#maintainers)
## Install
Asuming you alredy use [hyper](https://hyper.is) and [hpm](https://www.npmjs.com/package/hpm-cli)] (If you don't, please, go check them out)
```bash
hpm install hyperdocs
```
else, add it to your `~/.hyper.js` file
```js
plugins: ['hyperdocs']
```
Enjoy =)
## Usage
```bash
hyperdocs {language or framework}
```
for example:
```bash
hyperdocs react
```
If the documentation is found, it will open it right away. If it's not, it will open a [duckduckgo](https://duckduckgo.com/) search instead (currently broken due to duckduckgo not allowing to be shown in an iframe anymore [#14](https://github.com/uesteibar/hyperdocs/issues/14)).
## Running locally
Go to your hyper plugins folder
```bash
cd ~/.hyper_plugins/local
```
Clone the repository
```bash
git clone --depth=1 [email protected]:uesteibar/hyperdocs.git
```
Install dependencies
```bash
cd hyperdocs
npm install
```
Add to your `.hyper.js` file
```js
localPlugins: ['hyperdocs']
```
Every time you make a change, you have to
```bash
npm run build
```
and refresh your hyper terminal.
## Contributing
Pull request are welcome to add more docs =)
Just add the urls to [src/constants/urls.js](https://github.com/uesteibar/hyperdocs/blob/master/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):
1. when you land commits on your `master` branch, select the _Rebase and Merge_ option.
2. add a title and body that follows the [conventional-changelog-standard conventions][conventional-changelog-standard].
3. when you're ready to release a new version:
1. `git checkout master; git pull origin master`
2. run `npm run release`
## Helpers/Tools
- [Changelog](https://github.com/uesteibar/hyperdocs/blob/master/CHANGELOG.md)
- [Code of conduct](https://github.com/uesteibar/hyperdocs/blob/master/CHANGELOG.md)
- [commitizen](https://github.com/commitizen/cz-cli): 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](https://github.com/conventional-changelog/conventional-changelog) adapter.
- [conventional-changelog-standard](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md)
- [cz-conventional-changelog](https://github.com/commitizen/cz-conventional-changelog)
- [standard-version](https://github.com/conventional-changelog/standard-version)
## Maintainers
- [@uesteibar](https://github.com/uesteibar)