Skip to content

Velius-Development/VeliusDocs

Repository files navigation

Velius Engine Documentation

This repository is public to enable all users to fix and expand the documentation.
The main branch gets automatically deployed on velius.dev

How To Contribute

  • Clone the master branch of this repository
  • Use npm install to install all dependencies
  • Use npm run dev to run local development server

How to add a page

  • go into guide directory

  • add your page as a .md-file

  • add the name of the file you added without .md-Extension to /.vuepress/config.js

    themeConfig: {
    	...,
        sidebar: {
          '/guide/': [
            {
              ...,
              children: [
              	...,
                'example-page', <- Add this line
    

Thank you for contibuting!