JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 19
  • Score
    100M100P100Q41531F
  • License ISC

Get documentation right in your hyper terminal.

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

Standard Version npm version Code Climate npm

Get docs right in your hyper terminal.

demo

Install

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 =)

Usage

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).

Running locally

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 hyperdocs
npm 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.

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):

  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:
  4. git checkout master; git pull origin master
  5. run npm run release

Helpers/Tools

Maintainers