frodovdr
/
hyperion.ng
mirror of https://github.com/hyperion-project/hyperion.ng.git
1
0
Fork 0
Code Issues Releases Wiki Activity
hyperion.ng/docs
History
dependabot[bot] 423a59fa34
build(deps): bump websocket-extensions from 0.1.3 to 0.1.4 in /docs (#826) 
Bumps [websocket-extensions](https://github.com/faye/websocket-extensions-node) from 0.1.3 to 0.1.4.
- [Release notes](https://github.com/faye/websocket-extensions-node/releases)
- [Changelog](https://github.com/faye/websocket-extensions-node/blob/master/CHANGELOG.md)
- [Commits](https://github.com/faye/websocket-extensions-node/compare/0.1.3...0.1.4)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 		2020-06-08 15:46:10 +02:00
..
docs docs(device): Philips Hue Entertainment API Documentation (#806) 2020-05-25 21:42:52 +02:00
.gitignore feat(docs): Documentation for Hyperion (#780) 2020-05-01 20:19:19 +02:00
README.md feat(docs): Documentation for Hyperion (#780) 2020-05-01 20:19:19 +02:00
package.json feat(docs): Documentation for Hyperion (#780) 2020-05-01 20:19:19 +02:00
yarn.lock build(deps): bump websocket-extensions from 0.1.3 to 0.1.4 in /docs (#826) 2020-06-08 15:46:10 +02:00

README.md

Documentation

This folder contains the Hyperion documentation build files. It's written in Markdown with VuePress as static site generator.

Development

To edit or translate the documentation, it's not necessarily required to follow these steps (As we use Markdown). But if you want to check the results, please do so.

  • Install latest Node.js LTS
  • Open console
  • Install Yarn npm install -g yarn (If this does not work - logout/login)
  • Navigate with console to this directory
  • Do yarn install
  • Now you can start dev server with yarn docs:dev
  • Open Browser and go to address localhost:8080

Notes

  • If you want to view the deployable site locally run yarn docs:serve
  • Do not rename files and folders while translating
  • Copy/paste and translate also .vuepress/config.js at themeConfig.locales
  • Changes in .vuepress/config.js may lead to a bugged dev server. Restart.
  • To modify the sidebar pages checkout .vuepress/config.js at themeConfig.sidebar

Production

To get a deployable version run

  • yarn docs:build (while inside this folder)
  • Files will be in dist folder