docs: convert to vitepress
Some checks failed
ci/woodpecker/push/vitepress Pipeline failed
ci/woodpecker/push/jfmod Pipeline was successful

This commit is contained in:
Johannes Frohnmeyer 2024-09-30 17:39:35 +02:00
parent 13a0db79c9
commit e84137dd8d
Signed by: Johannes
GPG Key ID: E76429612C2929F4
9 changed files with 72 additions and 37 deletions

5
.gitignore vendored
View File

@ -123,4 +123,7 @@ runs/
bin bin
.project .project
.settings .settings
/public /public
/docs/.vitepress/cache
/node_modules
/package-lock.json

View File

@ -1,2 +1,2 @@
#link https://pages.frohnmeyer-wds.de/scripts/docs.yml #link https://pages.frohnmeyer-wds.de/scripts/vitepress.yml
#link https://pages.frohnmeyer-wds.de/scripts/jfmod.yml #link https://pages.frohnmeyer-wds.de/scripts/jfmod.yml

View File

@ -1,16 +0,0 @@
[book]
authors = ["JFronny"]
language = "en"
multilingual = false
src = "docs"
title = "LibJF"
description = "Documentation for the LibJF library"
[build]
build-dir = "public"
[output.html]
git-repository-url = "https://git.frohnmeyer-wds.de/JfMods/LibJF"
git-repository-icon = "fa-git-alt"
edit-url-template = "https://git.frohnmeyer-wds.de/JfMods/LibJF/_edit/master/{path}"
site-url = "https://pages.frohnmeyer-wds.de/JfMods/LibJF/"

View File

@ -0,0 +1,56 @@
import { defineConfig } from 'vitepress'
// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "LibJF",
description: "Documentation for the LibJF library",
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: 'Modrinth', link: 'https://modrinth.com/mod/libjf' },
{ text: 'CurseForge', link: 'https://www.curseforge.com/minecraft/mc-mods/libjf' }
],
sidebar: [
{
text: 'Modules',
collapsed: false,
items: [
{ text: 'libjf-base', link: '/libjf-base.md' },
{
text: 'Config',
collapsed: false,
link: '/config/index.md',
items: [
{ text: 'libjf-config-core-v2', link: '/config/libjf-config-core-v2.md' },
{ text: 'libjf-config-compiler-plugin-v2', link: '/config/libjf-config-compiler-plugin-v2.md' },
{ text: 'libjf-config-commands', link: '/config/libjf-config-commands.md' },
{ text: 'libjf-config-ui-tiny', link: '/config/libjf-config-ui-tiny.md' }
]
},
{ text: 'libjf-devutil', link: '/libjf-devutil.md' },
{ text: 'libjf-data-v0', link: '/libjf-data-v0.md' },
{ text: 'libjf-data-manipulation-v0', link: '/libjf-data-manipulation-v0.md' },
{ text: 'libjf-translate-v1', link: '/libjf-translate-v1.md' },
{ text: 'libjf-unsafe-v0', link: '/libjf-unsafe-v0.md' },
{ text: 'libjf-web-v1', link: '/libjf-web-v1.md' }
]
}
],
socialLinks: [
{ icon: 'github', link: 'https://git.frohnmeyer-wds.de/JfMods/LibJF' }
],
search: {
provider: "local"
},
},
outDir: '../public',
base: '/JfMods/LibJF/',
mpa: true,
lang: 'en-US',
sitemap: {
hostname: 'https://pages.frohnmeyer-wds.de/JfMods/LibJF/'
}
})

View File

@ -1,18 +0,0 @@
# Summary
- [About](./README.md)
# Modules
- [libjf-base](./libjf-base.md)
- [Config](./config/README.md)
- [libjf-config-core-v2](./config/libjf-config-core-v2.md)
- [libjf-config-compiler-plugin-v2](./config/libjf-config-compiler-plugin-v2.md)
- [libjf-config-commands](./config/libjf-config-commands.md)
- [libjf-config-ui-tiny](./config/libjf-config-ui-tiny.md)
- [libjf-devutil](./libjf-devutil.md)
- [libjf-data-v0](./libjf-data-v0.md)
- [libjf-data-manipulation-v0](./libjf-data-manipulation-v0.md)
- [libjf-translate-v1](./libjf-translate-v1.md)
- [libjf-unsafe-v0](./libjf-unsafe-v0.md)
- [libjf-web-v1](./libjf-web-v1.md)

View File

@ -16,4 +16,4 @@ Implement WebInit and register it as a libjf:web entrypoint. To enable the serve
``` ```
Please be aware that your entrypoint may be called multiple times during one session. Please be aware that your entrypoint may be called multiple times during one session.
You can register content providers using the register* methods on the WebServer parameter of your entrypoint. You can register content providers using the register* methods on the WebServer parameter of your entrypoint.
Please do not store it in a field, you may instead use WebServer.getInstance() if you wish to access it elsewhere. Please do not store it in a field, you may instead use `WebServer.getInstance()` if you wish to access it elsewhere.

10
package.json Normal file
View File

@ -0,0 +1,10 @@
{
"devDependencies": {
"vitepress": "^1.3.4"
},
"scripts": {
"docs:dev": "vitepress dev docs",
"docs:build": "vitepress build docs",
"docs:preview": "vitepress preview docs"
}
}