docs: convert to vitepress
This commit is contained in:
parent
d75e47a864
commit
cf9342843b
5
.gitignore
vendored
5
.gitignore
vendored
@ -6,4 +6,7 @@ imgui.ini
|
|||||||
hs_err_pid*
|
hs_err_pid*
|
||||||
inceptum.log
|
inceptum.log
|
||||||
bin
|
bin
|
||||||
public
|
public
|
||||||
|
/docs/.vitepress/cache
|
||||||
|
/node_modules
|
||||||
|
/package-lock.json
|
@ -1,4 +1,4 @@
|
|||||||
#link https://pages.frohnmeyer-wds.de/scripts/docs.yml
|
#link https://pages.frohnmeyer-wds.de/scripts/vitepress.yml
|
||||||
#include https://pages.frohnmeyer-wds.de/scripts/clone.yml
|
#include https://pages.frohnmeyer-wds.de/scripts/clone.yml
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
|
16
book.toml
16
book.toml
@ -1,16 +0,0 @@
|
|||||||
[book]
|
|
||||||
authors = ["JFronny"]
|
|
||||||
language = "en"
|
|
||||||
multilingual = false
|
|
||||||
src = "docs"
|
|
||||||
title = "LibJF"
|
|
||||||
description = "Inceptum Docs"
|
|
||||||
|
|
||||||
[build]
|
|
||||||
build-dir = "public"
|
|
||||||
|
|
||||||
[output.html]
|
|
||||||
git-repository-url = "https://git.frohnmeyer-wds.de/JfMods/Inceptum"
|
|
||||||
git-repository-icon = "fa-git-alt"
|
|
||||||
edit-url-template = "https://git.frohnmeyer-wds.de/JfMods/Inceptum/_edit/master/{path}"
|
|
||||||
site-url = "https://pages.frohnmeyer-wds.de/JfMods/Inceptum/"
|
|
33
docs/.vitepress/config.mts
Normal file
33
docs/.vitepress/config.mts
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
import { defineConfig } from 'vitepress'
|
||||||
|
|
||||||
|
// https://vitepress.dev/reference/site-config
|
||||||
|
export default defineConfig({
|
||||||
|
title: "Inceptum",
|
||||||
|
description: "Inceptum Docs",
|
||||||
|
themeConfig: {
|
||||||
|
// https://vitepress.dev/reference/default-theme-config
|
||||||
|
sidebar: [
|
||||||
|
{ text: 'About', link: '/index.md' },
|
||||||
|
{ text: 'Installing', link: '/Installing.md' },
|
||||||
|
{ text: 'CLI', link: '/Commands.md' },
|
||||||
|
{ text: 'Syncing instances', link: '/Syncing.md' },
|
||||||
|
{ text: 'File Formats', link: '/FileFormats.md' },
|
||||||
|
{ text: 'Modules', link: '/Modules.md' }
|
||||||
|
],
|
||||||
|
|
||||||
|
socialLinks: [
|
||||||
|
{ icon: 'github', link: 'https://git.frohnmeyer-wds.de/JfMods/Inceptum' }
|
||||||
|
],
|
||||||
|
|
||||||
|
search: {
|
||||||
|
provider: "local"
|
||||||
|
},
|
||||||
|
},
|
||||||
|
outDir: '../public',
|
||||||
|
base: '/JfMods/Inceptum/',
|
||||||
|
mpa: true,
|
||||||
|
lang: 'en-US',
|
||||||
|
sitemap: {
|
||||||
|
hostname: 'https://pages.frohnmeyer-wds.de/JfMods/Inceptum/'
|
||||||
|
}
|
||||||
|
})
|
@ -1,8 +0,0 @@
|
|||||||
# Summary
|
|
||||||
|
|
||||||
- [About](./README.md)
|
|
||||||
- [Installing](./Installing.md)
|
|
||||||
- [CLI](./Commands.md)
|
|
||||||
- [Syncing instances](./Syncing.md)
|
|
||||||
- [File Formats](./FileFormats.md)
|
|
||||||
- [Modules](./Modules.md)
|
|
10
package.json
Normal file
10
package.json
Normal 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"
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user