uesteibar/hyperdocs

(UNSUPPORTED) Get docs right in your hyper terminal.

hyperdocs

Get docs right in your hyper terminal.

• Install
• Usage
• Running Locally
• Contributing
• Helpers/Tools
• Maintainers

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 [email protected]: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

• 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

Maintainers

• @uesteibar

hyperdocs's Issues

README.md has outdated URL to the gif image

Expected Behavior

• README.md should have a working image URL, that would display the real content.

Current Behavior

• README.md file has an outdated image URL that no longer points to the original image file.
• Caused by the changed URL structure of the Gifyu image gallery service.

![demo](https://gifyu.com/images/hyperdocs.gif)

npm package page

GitHub repository Markdown preview

Possible Solution

• Search for the new URL from your preferred image gallery service.
• Consider changing to an another image gallery service, if needed.
• Update image URL to a working URL path.

Steps to Reproduce (for bugs)

1. Open hyperdocs - npm package page.
2. See the image that says: "We have updated URL of this image. Please visit our site to get the updated link. Contact support for help. Gifyu.com"
3. Open uesteibar/hyperdocs page, and look at the missing image placeholder.
4. Open README.md source code, and look how the image URL is currently embedded.

Context

Your Environment

• Version used: baa9ccf
• Operating System:

Getting commandNotFound documentation

Hi, I have just installed hyperdocs plugin using hpm and ran it inside zsh shell. It triggered the internal browser window with duckduckgo search... but it used commandNotFound documentation as the search text. In another try, it used something like this 0m39sreactK command for the search text. Could you please investigate or point out what's the issue? Appreciate the effort!

Add search fallback when documentation is not found

It could be a duckduckgo search as a fallback.

Parametrizable URLS

For getting packages for a language, like hyperdocs gem foobar => "http://www.rubydoc.info/gems/foobar/".

Add Issue and Pull Request templates

Update prettier to ^1.2 and better config

Expected Behavior

Prettier should also fix spaces inside brackets and other fancy new stuff they added lately.

Current Behavior

Right now prettier does not fix this things.

Possible Solution

Update prettier and improve pretier npm script params.

Plugin load error: "hyperdocs" failed to load in the renderer process.

Plugin won't load due to an error Cannot read property 'instanceOf' of undefined in react-jss, not sure what triggers it though.

Expected Behavior

Should load on Linux

Current Behavior

Does not load. Please see image from Developer Tools.

Pasting error output here for text search reference:

TypeError: Cannot read property 'instanceOf' of undefined
    at Object.<anonymous> (/home/afigueiredo/.hyper_plugins/node_modules/react-jss/lib/SheetsRegistryProvider.js:56)
    at Object.<anonymous> (/home/afigueiredo/.hyper_plugins/node_modules/react-jss/lib/SheetsRegistryProvider.js:63)
    at Module._compile (module.js:571)
    at Object.Module._extensions..js (module.js:580)
    at Module.load (module.js:488)
    at tryModuleLoad (module.js:447)
    at Function.Module._load (module.js:439)
    at Function.c._load (bundle.js:1)
    at Module.require (module.js:498)
    at require (internal/module.js:20)
D.e.plugins.concat.filter.map @ bundle.js:1
D @ bundle.js:1
(anonymous) @ bundle.js:1
__webpack_require__ @ bundle.js:1
(anonymous) @ bundle.js:4
__webpack_require__ @ bundle.js:1
(anonymous) @ bundle.js:1
(anonymous) @ bundle.js:1

Possible Solution

Steps to Reproduce (for bugs)

1. Install Hyper in Linux
2. Install latest hyperdocs
3. Enter Hyper

Context

Your Environment

• Version used: latest (1.1.3)
• Operating System: Linux Mint 18.2

Calling "hyperdocs react" freezes.. Invalid regular expression Error

Expected Behavior

hyperdocs react should take me to the react docs

Current Behavior

The plugin hands and the developer tools says

Uncaught SyntaxError: Invalid regular expression: /(?<=hyperdocs).*/: Invalid group
    at /Users/me/.hyper_plugins/node_modules/hyperdocs/lib/index.js:67:54

Possible Solution

Fix the regular expression

Steps to Reproduce (for bugs)

Type hyperdocs python into terminal.

Context

Your Environment

• MacOS Sierra 10.12.4
• Hyper 1.4.8 (stable)

Plugins

• hyper-transparent (1.1.3),
• hyperterm-dibdabs (0.0.8),
• hyperterm-tabs (1.3.5),
• hyperlinks (0.5.0)
• hyper-alt-click (0.1.1),
• hyperterm-tabs (1.3.5),
• hyperdocs (1.1.3)

Find alternative to DuckDuckGo for fallbacks

Currently when trying to show a duckduckgo search within an iframe, we get the following error:

Refused to display 'https://duckduckgo.com/...` in a frame because an ancestor violates the following Content Security Policy directive: "frame-ancestors 'self'"

Maybe would be a good idea to find an alternative search engine to show the results.

Any proposal out there?

Use CLI to capture command instead of parsing the error

Similar to what hyperchart is doing here