https://github.com/hyperion-project/hyperion.docs

The official documentation for Hyperion
https://github.com/hyperion-project/hyperion.docs

documentation hyperbian hyperion hyperion-project vuepress

Last synced: 7 days ago
JSON representation

The official documentation for Hyperion

• Host: GitHub
• URL: https://github.com/hyperion-project/hyperion.docs
• Owner: hyperion-project
• License: mit
• Created: 2021-03-14T15:03:44.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-03T17:59:26.000Z (6 months ago)
• Last Synced: 2024-06-10T05:36:18.983Z (5 months ago)
• Topics: documentation, hyperbian, hyperion, hyperion-project, vuepress
• Homepage: https://docs.hyperion-project.org
• Size: 14.9 MB
• Stars: 15
• Watchers: 6
• Forks: 208
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Documentation

This repository contains the [Hyperion](https://github.com/hyperion-project/hyperion.ng) documentation build files. It's written in Markdown with [VitePress](https://vitepress.dev) 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](https://nodejs.org/en)

 - Open console, clone this repository and navigate into it

 - Do `npm install`

 - Now you can start dev server with `npm run docs:dev`

 - Open Browser and go to address `localhost:5173`

 

#### Notes

 - Do not rename files and folders while translating

 - To modify the sidebar/navbar checkout the folder `docs/.vitepress/configs`

### Production

To get a deployable version run

 - `npm run docs:build` (while inside this folder)

 - Files will be in `docs/dist` folder