The static files that are shipped to end users are generated using Vitepress. A full documentation on how to use Vitepress can be found here: https://vitepress.dev/guide/getting-started
For development, use yarn install followed by yarn docs:dev and navigate to http://localhost:5173.
For a production build, use yarn docs:build.
.
├── src/ # Vitepress "srcDir"
│ ├── multiplayer-servers/ # Multiplayer Server specific documentation
│ │ ├── general/ # Content directories per section, in order
│ │ │ └── sidebar.json # Definition of navigation for that section
│ │ ├── api/
│ ├── index.md # Index page
│ ├── public/ # Static, global assets
│ │ └── gf.png
├── vite.config.js
├── .vitepress/
│ ├── config.js # Contains code for sidebar rendering and general config
│ └── theme/
│ ├── custom.css
│ └── index.js
├── package.json
├── README.md
└── yarn.lock
To contribute to the documentation, simply edit the relevant files within the appropriate subfolder in src or create a new subfolder following the established naming convention.
To include new pages in the navigation, modify the sidebar.json file within the respective folder, ensuring you add the order property to maintain the correct sequence in the sidebar.
All changes are automatically integrated into .vitepress/config.js. You can refer to existing examples or consult the
Vitepress Documentation or guidance on configuring sidebars.
API Specs are placed in the src/api folder using the preexisting component.
To add new specs simply create a new markdown file for the desired spec and add the following code to it:
---
layout: page
---
<script setup>
import OpenAPI from '../components/OpenAPI.vue'
</script>
<OpenAPI spec-url="$SPEC_URL"/>Afterwards it can be referenced in the .vitepress/config.js.
GameFabric Documentation by marbis GmbH is licensed under CC BY-NC 4.0
