documentation page (but actually good)

team.md not finalized so not included

.github/workflows/deploy.yml

@@ -0,0 +1,66 @@
+# Sample workflow for building and deploying a VitePress site to GitHub Pages
+#
+name: Deploy VitePress site to Pages
+
+on:
+  # Runs on pushes targeting the `main` branch. Change this to `master` if you're
+  # using the `master` branch as the default branch.
+  push:
+    branches: [main]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Not needed if lastUpdated is not enabled
+      # - uses: pnpm/action-setup@v3 # Uncomment this block if you're using pnpm
+      #   with:
+      #     version: 9 # Not needed if you've set "packageManager" in package.json
+      # - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm # or pnpm / yarn
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: npm ci # or pnpm install / yarn install / bun install
+      - name: Build with VitePress
+        run: npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,4 @@
+.vuepress/cache
+node_modules
+dist
+package-lock.json

.vitepress/config.mts

@@ -0,0 +1,107 @@
+import { defineConfig, HeadConfig } from 'vitepress';
+import { generateSidebar } from 'vitepress-sidebar';
+import { withPwa } from '@vite-pwa/vitepress'
+
+
+export default withPwa(defineConfig({
+  title: 'Project Lodestone - Documentation',
+  description: 'Documentation for Project Lodestone and various file formats and mechanics for many versions and editions of Minecraft.',
+  lastUpdated: true,
+  outDir: "dist",
+  sitemap: {
+    hostname: 'https://team-lodestone.github.io/Documentation/'
+  },
+  themeConfig: {
+    siteTitle: false,
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'LCE', link: '/LCE/readme.md' },
+      { text: 'Java', link: '/Java/readme.md' },
+      { text: 'Bedrock', link: '/Bedrock/readme.md' },
+      { text: '3DS', link: '/3DS/readme.md' },
+      { text: 'Pi', link: '/Pi/Pi-Edition-Docs.md' },
+      { text: 'Info', link: '/readme.md' },
+      { text: 'Team', link: '/Team.md' },
+    ],
+
+    search: {
+      provider: 'local'
+    },
+
+    sidebar: generateSidebar({
+      documentRootPath: "/",
+      collapsed: true,
+      capitalizeEachWords: true,
+      rootGroupText: 'Main',
+      hyphenToSpace: true,
+      includeEmptyFolder: false
+    }),
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/Team-Lodestone' },
+      { icon: 'discord', link: 'https://discord.gg/eHdmrW7W6u' }
+    ],
+
+    footer: {
+      // haha inlining html into a text block
+      message: '<h1>Contributors</h1><br><a href="https://github.com/Team-Lodestone/Documentation/graphs/contributors" style="display: flex; justify-content: center; align-items: center;" > <img align="center" src="https://contrib.rocks/image?repo=Team-Lodestone/Documentation"/> </a><br><h1>Documentation page was setup by DexrnZacAttack.</h1>',
+    },
+
+    logo: './assets/Project_Dexrn_Lodestone_Logo_Made_By_NikStudios.svg'
+  },
+  head: [
+    // gotta have all the meta tags
+    ['link', { rel: 'icon', href: '/assets/Lodestone_Favicon.png' }],
+    ['link', { rel: 'shortcut icon', href: '/assets/Lodestone_Favicon.png' }],
+    ['link', { rel: 'apple-touch-icon', sizes: '512x512', href: '/assets/Dexrn_Lodestone_Logo.png' }],
+    ['link', { rel: 'stylesheet', type: 'text/css', href: '/assets/lodestone.css' }],
+    ['meta', { property: 'og:image', content: '/assets/LodestoneBg.jpg' }],
+    ['meta', { property: 'og:type', content: 'website' }],
+    ['meta', { property: 'theme-color', content: '#AD95ED' }],
+    ['meta', { name: 'description', content: 'Documentation for Project Lodestone and various file formats and mechanics for many versions and editions of Minecraft.' }],
+    // do these even do anything
+    ['meta', { name: 'keywords', content: 'minecraft, lodestone, world converter, converter, legacy console edition, lce, java edition, java, documentation, bedrock edition, bedrock, pi edition, pi, 3ds edition, 3ds' }],
+    // lol does this mean it can be shoved into the start menu as a "live" tile
+    ['meta', { name: 'msapplication-TileColor', content: '#AD95ED' }],
+    ['meta', { name: 'msapplication-TileImage', content: '/assets/Dexrn_Lodestone_Logo.png' }],
+  ],
+  vite: {
+    server: {
+      host: '0.0.0.0', 
+      port: 80,     
+    }
+  },
+  transformHead: ({ pageData }) => {
+    const head: HeadConfig[] = []
+
+    // for other platforms ig
+    head.push(['meta', { property: 'og:title', content: "Project Lodestone - Documentation > " + pageData.relativePath }]);
+    head.push(['meta', { property: 'og:description', content: "Documentation for Project Lodestone and various file formats and mechanics for many versions and editions of Minecraft." }])
+    head.push(['meta', { property: 'og:url', content: 'https://Team-Lodestone.github.io/Documentation/' + pageData.relativePath }]); // this might be messed up idk
+    // xitter
+    head.push(['meta', { name: 'twitter:title', content: "Project Lodestone - Documentation > " + pageData.relativePath }]);
+    head.push(['meta', { name: 'twitter:description', content: "Documentation for Project Lodestone and various file formats and mechanics for many versions and editions of Minecraft." }]);
+    head.push(['meta', { name: 'twitter:url', content: 'https://Team-Lodestone.github.io/Documentation/' + pageData.relativePath }]);
+    head.push(['meta', { name: 'twitter:image', content: '/assets/LodestoneBg.jpg' }]);
+
+    return head
+  },
+  ignoreDeadLinks: true,
+  pwa: {
+    registerType: 'autoUpdate',
+    manifest: {
+      name: 'Project Lodestone - Documentation',
+      short_name: 'Project Lodestone Docs',
+      description: '',
+      theme_color: '#493189', 
+      icons: [
+        {
+          src: '/assets/Dexrn_Lodestone_Logo.png',
+          sizes: '512x512',
+          type: 'image/png',
+        },
+      ],
+    },
+  },
+}));
+

ColoringNotes.md

@@ -11,6 +11,7 @@ Format: <img valign="middle" src="https://readme-swatches.vercel.app/<HexCode>?s
 | Used For | RGB Color Code | Hex Color Code | Notes | Color |
 |----------|----------------|----------------|-------|:-:|
 | Primary Color (Our purple/lavender) | `rgb(173,149,237)` | `#ad95ed` | | <img valign="middle" src="https://readme-swatches.vercel.app/ad95ed?style=round"> |
+| Dark mode primary Color (Our purple/lavender) | `rgb(73,49,137)` | `#493189` | | <img valign="middle" src="https://readme-swatches.vercel.app/493189?style=round"> |
 | Background Color | `rgb(26,23,34)` | `#1a1722` | | <img valign="middle" src="https://readme-swatches.vercel.app/1a1722?style=round"> |
 | Success Color | `rgb(?,?,?)` | `#??????` | Some kind of green. | |
 | Warning Color | `rgb(?,?,?)` | `#??????` | Some kind of yellow. | |

LCE/File Types/NBT.md

@@ -66,7 +66,7 @@ TAG_Compound
 
 ## Inventory Data
 Inventory data is stored within player NBT structures and represents the items a player carries.
-```
+```nbt
 TAG_List
 [
     TAG_Compound {...},  # Item 1
@@ -77,7 +77,7 @@ TAG_List
 
 ## World Data
 World data includes information about the game world, blocks, entities, and more. This data is saved in region files.
-```
+```nbt
 TAG_Compound
 {
     "Level": TAG_Compound

LCE/README.md

@@ -1,5 +1,7 @@
 # LCE-Documentation
 Documentation about Minecraft: Legacy Console Edition related stuff.
 
+For basic LCE info such as compression, endianness, etc, check out [Basic Info.md](./Basic%20Info.md)
+
 # Contributors
-List of contributors can be found under [Team.md#Documentation](/Team.md#Documentation)
+List of contributors can be found under [Team.md#Documentation](/Team.md#Documentation)

README.md

@@ -38,8 +38,8 @@ We're continuously working on new features and improvements. Here's an outline o
   - [ ] Community-made modifications
 
 ### **Extra tools**
-  - [x] NBT Editor (with S-NBT support).
-  - [x] Hex Editor
+  - [X] NBT Editor (with S-NBT support).
+  - [X] Hex Editor
   - [ ] LevelDB Browser
   - [ ] Datapack Editor
   - [ ] Other tools:
@@ -53,7 +53,7 @@ We're continuously working on new features and improvements. Here's an outline o
   - [ ] Custom resource packs & texture pack modifications.
 
 ### **Web UI**
-  - [x] UI planned out
+  - [X] UI planned out
   - [ ] UI completed
   - [ ] Localization
   - [ ] Accessibility

index.md

@@ -0,0 +1,32 @@
+---
+layout: home
+
+hero:
+  name: "Project Lodestone - Documentation"
+  tagline: "Documentation for Project Lodestone and various file formats and mechanics for many versions and editions of Minecraft."
+features:
+  - title: Project Info
+    details: Info about Project Lodestone
+    link: /readme.md
+    icon: ℹ️
+  - title: Legacy Console Edition
+    details: Documentation on the Legacy Console Edition (LCE) versions Of Minecraft
+    link: /LCE/readme.md
+    icon: 🎮
+  - title: Java Edition
+    details: Documentation on Minecraft Java Edition
+    link: /Java/readme.md
+    icon: 🖥️
+  - title: Bedrock Edition
+    details: Documentation on Minecraft Bedrock Edition
+    link: /Bedrock/readme.md
+    icon: 📱
+  - title: 3DS Edition
+    details: Documentation on Minecraft 3DS Edition
+    link: /3DS/readme.md
+  - title: Pi Edition
+    details: Documentation on Minecraft Pi Edition
+    link: /Pi/readme.md
+    icon: ⌨️
+---
+

package.json

@@ -0,0 +1,12 @@
+{
+  "scripts": {
+    "docs:dev": "vitepress dev",
+    "docs:build": "vitepress build",
+    "docs:preview": "vitepress preview"
+  },
+  "devDependencies": {
+    "@vite-pwa/vitepress": "^0.5.3",
+    "vitepress": "^1.4.2",
+    "vitepress-sidebar": "^1.28.0"
+  }
+}

public/assets/lodestone.css

@@ -0,0 +1,19 @@
+:root.dark {
+    --vp-home-hero-name-color: rgb(173,149,237);
+    --vp-nav-bg-color: rgb(25,26,28);
+    --vp-sidebar-bg-color: rgb(25,26,28);
+    --vp-c-brand-1: rgb(173,149,237);
+    --vp-c-accent: rgb(173,149,237);
+    --vp-c-bg: rgb(18,18,18);
+    --vp-c-accent: rgb(173,149,237);
+}
+
+:root {
+    --vp-c-brand-1: rgb(73,49,137);
+    --vp-c-accent: rgb(73,49,137);
+    transition: background-color 0.55s;
+}
+
+.VPNav {
+    background-color: var(--vp-nav-bg-color);
+}