This repository contains the Hyperion documentation build files. It's written in Markdown with VuePress as static site generator.
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) - Clone this repository and navigate into it
- Do
yarn install - Now you can start dev server with
yarn docs:dev - Open Browser and go to address
localhost:8080
- 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.jsatthemeConfig.locales - Changes in
.vuepress/config.jsmay lead to a bugged dev server. Restart. - To modify the sidebar pages checkout
.vuepress/config.jsatthemeConfig.sidebar
To get a deployable version run
yarn docs:build(while inside this folder)- Files will be in
distfolder