{"id":16482338,"url":"https://github.com/uesteibar/hyperdocs","last_synced_at":"2025-03-23T11:33:17.464Z","repository":{"id":57270171,"uuid":"87719642","full_name":"uesteibar/hyperdocs","owner":"uesteibar","description":"(UNSUPPORTED) Get docs right in your hyper terminal.","archived":false,"fork":false,"pushed_at":"2019-01-11T22:54:21.000Z","size":29,"stargazers_count":13,"open_issues_count":1,"forks_count":7,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-18T20:16:04.274Z","etag":null,"topics":["deprecated","docsearch","documentation","hyper","hyper-app","hyper-plugin","hyperterm"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/hyperdocs","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/uesteibar.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-04-09T15:45:05.000Z","updated_at":"2024-06-01T16:38:07.000Z","dependencies_parsed_at":"2022-08-25T02:51:35.972Z","dependency_job_id":null,"html_url":"https://github.com/uesteibar/hyperdocs","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uesteibar%2Fhyperdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uesteibar%2Fhyperdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uesteibar%2Fhyperdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uesteibar%2Fhyperdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/uesteibar","download_url":"https://codeload.github.com/uesteibar/hyperdocs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245097196,"owners_count":20560311,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["deprecated","docsearch","documentation","hyper","hyper-app","hyper-plugin","hyperterm"],"created_at":"2024-10-11T13:10:25.294Z","updated_at":"2025-03-23T11:33:16.411Z","avatar_url":"https://github.com/uesteibar.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# hyperdocs\n\n[![Standard Version](https://img.shields.io/badge/release-standard%20version-brightgreen.svg)]()\n[![npm version](https://badge.fury.io/js/hyperdocs.svg)](https://badge.fury.io/js/hyperdocs)\n[![Code Climate](https://codeclimate.com/github/uesteibar/hyperdocs/badges/gpa.svg)](https://codeclimate.com/github/uesteibar/hyperdocs)\n[![npm](https://img.shields.io/npm/dm/hyperdocs.svg?label=DL)]()\n\nGet docs right in your hyper terminal.\n\n![demo](https://gifyu.com/images/hyperdocs.gif)\n\n- [Install](#install)\n- [Usage](#usage)\n- [Running Locally](#running-locally)\n- [Contributing](#contributing)\n- [Helpers/Tools](#helperstools)\n- [Maintainers](#maintainers)\n\n## Install\n\nAsuming 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)\n```bash\nhpm install hyperdocs\n```\n\nelse, add it to your `~/.hyper.js` file\n```js\nplugins: ['hyperdocs']\n```\n\nEnjoy =)\n\n## Usage\n\n```bash\nhyperdocs {language or framework}\n```\n\nfor example:\n```bash\nhyperdocs react\n```\n\nIf 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)).\n\n## Running locally\n\nGo to your hyper plugins folder\n```bash\ncd ~/.hyper_plugins/local\n```\n\nClone the repository\n```bash\ngit clone --depth=1 git@github.com:uesteibar/hyperdocs.git\n```\n\nInstall dependencies\n```bash\ncd hyperdocs\nnpm install\n```\n\nAdd to your `.hyper.js` file\n```js\nlocalPlugins: ['hyperdocs']\n```\n\nEvery time you make a change, you have to\n```bash\nnpm run build\n```\n\nand refresh your hyper terminal.\n\n## Contributing\n\nPull request are welcome to add more docs =)\nJust add the urls to [src/constants/urls.js](https://github.com/uesteibar/hyperdocs/blob/master/src/constants/urls.js).\n\nThe 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.\n\nSo this is a step by step guide to contributing to the project (mostly extracted from the [`standard-version`][standard-version] docs):\n\n1. when you land commits on your `master` branch, select the _Rebase and Merge_ option.\n2. add a title and body that follows the [conventional-changelog-standard conventions][conventional-changelog-standard].\n3. when you're ready to release a new version:\n  1. `git checkout master; git pull origin master`\n  2. run `npm run release`\n\n## Helpers/Tools\n\n- [Changelog](https://github.com/uesteibar/hyperdocs/blob/master/CHANGELOG.md)\n- [Code of conduct](https://github.com/uesteibar/hyperdocs/blob/master/CHANGELOG.md)\n- [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.\n- [conventional-changelog-standard](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md)\n- [cz-conventional-changelog](https://github.com/commitizen/cz-conventional-changelog)\n- [standard-version](https://github.com/conventional-changelog/standard-version)\n\n## Maintainers\n\n- [@uesteibar](https://github.com/uesteibar)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuesteibar%2Fhyperdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuesteibar%2Fhyperdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuesteibar%2Fhyperdocs/lists"}