From cf9342843b07b676f5327acd0bd2143629f5c0c4 Mon Sep 17 00:00:00 2001 From: JFronny Date: Mon, 30 Sep 2024 17:42:57 +0200 Subject: [PATCH] docs: convert to vitepress --- .gitignore | 5 ++++- .woodpecker.yml | 2 +- book.toml | 16 ---------------- docs/.vitepress/config.mts | 33 +++++++++++++++++++++++++++++++++ docs/SUMMARY.md | 8 -------- docs/{README.md => index.md} | 0 package.json | 10 ++++++++++ 7 files changed, 48 insertions(+), 26 deletions(-) delete mode 100644 book.toml create mode 100644 docs/.vitepress/config.mts delete mode 100644 docs/SUMMARY.md rename docs/{README.md => index.md} (100%) create mode 100644 package.json diff --git a/.gitignore b/.gitignore index 69c7a7d..8c40d0c 100644 --- a/.gitignore +++ b/.gitignore @@ -6,4 +6,7 @@ imgui.ini hs_err_pid* inceptum.log bin -public \ No newline at end of file +public +/docs/.vitepress/cache +/node_modules +/package-lock.json \ No newline at end of file diff --git a/.woodpecker.yml b/.woodpecker.yml index 5b7dd1d..751f9a3 100644 --- a/.woodpecker.yml +++ b/.woodpecker.yml @@ -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 steps: diff --git a/book.toml b/book.toml deleted file mode 100644 index 1870993..0000000 --- a/book.toml +++ /dev/null @@ -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/" diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts new file mode 100644 index 0000000..5209cd8 --- /dev/null +++ b/docs/.vitepress/config.mts @@ -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/' + } +}) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md deleted file mode 100644 index 4350b7d..0000000 --- a/docs/SUMMARY.md +++ /dev/null @@ -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) \ No newline at end of file diff --git a/docs/README.md b/docs/index.md similarity index 100% rename from docs/README.md rename to docs/index.md diff --git a/package.json b/package.json new file mode 100644 index 0000000..253bbad --- /dev/null +++ b/package.json @@ -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" + } +} \ No newline at end of file