hyperion.ng

History

Calvin 2b66754997 Update Documentation (#1162 ) * Add information on WLED to documentation Add information how to force max brightness in WLED. See Issue #1101 * Translated Installation.md to german Translation and added short instructions to WIN 10 installation. * Removed Typo * Added Windows 10 instructions * Update Installation.md		2021-02-23 20:39:18 +01:00
..
development	[ImgBot] Optimize images (#1058 )	2020-10-22 17:32:18 +02:00
docs	Update Documentation (#1162 )	2021-02-23 20:39:18 +01: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 ini from 1.3.5 to 1.3.8 in /docs (#1118 )	2020-12-13 10:25:02 +01: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