From 41e61498280315d920ff8ba00cc837a4778154fe Mon Sep 17 00:00:00 2001 From: Robert Jelic <36573031+NoryiE@users.noreply.github.com> Date: Sun, 16 Feb 2025 18:01:30 +0100 Subject: [PATCH] Fix --- docs/.vitepress/config.mts | 83 ++++++++++++++++++++++++++++++++++++++ docs/index.md | 31 ++++++++++++++ docs/references.md | 1 + 3 files changed, 115 insertions(+) create mode 100644 docs/.vitepress/config.mts create mode 100644 docs/index.md create mode 100644 docs/references.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts new file mode 100644 index 0000000..6d91924 --- /dev/null +++ b/docs/.vitepress/config.mts @@ -0,0 +1,83 @@ +import { defineConfig } from 'vitepress' + +// https://vitepress.dev/reference/site-config +export default defineConfig({ + title: "Basalt", + description: "A UI Framework made for CC:Tweaked", + lang: 'en-US', + lastUpdated: true, + base: "/Basalt2/", + + head: [ + //[ + // 'link', + // { rel: 'stylesheet', href: '../css/computer.css', type: 'text/css' } + //], + //[ + // 'script', + // { async: '', src: 'https://copy-cat.squiddev.cc/require.js' } + //], + //[ + // 'script', + // {}, + // `require.config({ paths: { copycat: "https://copy-cat.squiddev.cc/" } }); + // require(["copycat/embed"], setup => setup(document.getElementById("embed-computer")));` + //], + //[ + // 'script', + // {src: '../js/computer.js' }, + //], + + //HTML for this: + // + //
+ //
+ //
+ ], + + themeConfig: { + editLink: { + pattern: 'https://github.com/Pyroxenium/Basalt2/tree/gh-pages/docs/:path' + }, + search: { + provider: 'local' + }, + + outline: 2, + footer: { + message: 'Released under the MIT License.', + copyright: 'Copyright © 2025 Robert Jelic' + }, + nav: [ + { text: 'Home', link: '/home' }, + { text: 'References', link: '/references/main' }, + ], + + docFooter: { + prev: false, + next: false + }, + + sidebar: { + '/guides/': [ + + ], + + '/references/':[ + { + text: 'References', link: 'references/main', + items: [ + {text: 'Basalt', link: 'references/basalt'}, + {text: 'Element', link: 'references/baseelement'}, + {text: 'Frame', link: 'references/frame'}, + ] + } + ] + }, + + + socialLinks: [ + { icon: 'github', link: 'https://github.com/Pyroxenium/Basalt2' } + ] + } +}) diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..5690935 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,31 @@ +--- +# https://vitepress.dev/reference/default-theme-home-page +layout: home + +hero: + name: "Basalt" + text: Official Documentation + tagline: A CC:Tweaked UI Framework + actions: + - theme: brand + text: Home + link: /guides/ + - theme: alt + text: Guides + link: guides/getting-started + - theme: alt + text: References + link: /references + - theme: alt + text: Github + link: https://github.com/Pyroxenium/Basalt/tree/basalt2 + +features: + - title: User friendly + details: Basalt's intuitive interface makes UI design a breeze, even for beginners. Experience seamless integration without the steep learning curve. + - title: High Performance + details: Designed with efficiency in mind, Basalt ensures smooth and responsive interfaces, even for the most complex applications. + - title: Modular Design + details: With a rich set of objects and modules, Basalt allows you to craft custom experiences, scaling up or down based on your needs. +--- + diff --git a/docs/references.md b/docs/references.md new file mode 100644 index 0000000..baeaace --- /dev/null +++ b/docs/references.md @@ -0,0 +1 @@ +# References Page \ No newline at end of file