feat: wiki

Pr #28 * feat: wiki & news in content * fix: theme color * fix: biome * fix: biome formating * fix: biome config * fix: biome * feat: wiki first page Co-authored-by: DuckeyDev <[email protected]> * feat: blur * feat: wiki home page * feat: wiki content page * feat: moving news over to content * fix: staff application * feat: the new wiki added to nav bar * fix: wikicontent to have a back button & representing colors for the documentation * feat: wiki init * feat: configSchema * chore: moved all formating to dprint and removed unless deps * fix: formatting with dprint * fix: package json to be dprint * fix: package json formatting * fix: reccomend extensions that you need for this repo * fix: theme color * feat: configSchema * chore: removed quaility for now * fix: emails. * chore: added back mailto * chore: moved all formating to dprint and removed unless deps * fix: formatting with dprint * fix: merge commit * fix: biome * feat: configSchema * chore: removed an email for now * chore: remove biome & cleaned up deps * fix: formatting & issues * feat: nix setup * chore: updated flake lock * fix: git ignore * fix: includes in dprint * fix: e2e testing for nix * chore: update deps * fix: estimate * fix: formating * chore: removed astro-page-insight for now since it has issue with bun * chore: added nice colors to estimate * feat: code theme * fix: api error code to be num * fix: seo * chore: orgnized assets * fix: fmt for home page * chore: removed markup due to an issue * fix: fmt in astro config * fix: fmt of dprint config * feat: env example * fix: config schema * chore: removed requirement for gh pat token as it doesn't need it * feat: news template * fix: do not repeat yourself * fix: mobile header * chore: added extra class to footer for wiki * chore: added extraFooterClass option to wiki posts * fix: footer for main page * fix: banner for staff apps news * feat: wiki news * fix: footer issue with news posts & issues on the sides * fix: formating * fix: header colors for mobile * chore: removed mod api documentation for now * feat: desc to docs * fix: newspost sizing * chore: made it easier to change classes * chore: moved installation to getting started * feat: wiki groups * feat: color api notices * fix: type issues * fix: font for sub catacategory's * chore: changed h1 to h2 based on text size * feat: improved documentation for errors on api * feat: Disclaimers * chore: removed privacy policy for now * feat: new layout for docs * feat: new term for sourcing TeaClient for package managers * fix: footer * fix: title to be inside box * fix: govering law * feat: clarification of age in areas * feat: wip pages * feat: adjusted colors for expressive code theme * chore: cleaned up code * feat: github theme * chore: removed a console log from wiki index * feat: schema inits. * chore: made nice updates to desc and title to developer api docs * fix: terms to be consise * feat: warranty & Liabillity * chore: update date for terms * fix: colors issue * feat: communites page * fix: fmting * feat: communites page * fix: colors issue * chore: update date for terms * feat: warranty & Liabillity * fix: terms to be consise * chore: made nice updates to desc and title to developer api docs * feat: schema inits. * feat: schema inits. * chore: removed a console log from wiki index * fix: fmting * chore: removed un-needed documenation * chore: added global var * fix: sub catagories * chore: prepare view transitions * feat: tab component initial commit * chore: implement tab component example * chore: moved tab component to tailwind * chore: tabgroup component moved to wiki * chore: deprecating old path aliases and now @/ is src * fix: wiki content issues * fix: component imports having double ss * fix: ts config path alias * fix: path to tab component * chore: removed an unneeded console * feat: package managers install guide * feat: mod documentation init * feat: api url config * fix: quality check 1/2 * chore: updated role in newsposts This is to be more professional * Starlight astro (#30) * chore: moved to starlight * feat: finished starlight * feat: new wiki styling * feat: wellcome for getting started * fix: player doc link * fix: indenting * fix: player doc link * feat: servers list documentation * chore: removed svgs * feat: Links init * chore: moved pages to redirects * chore: improvements * chore: fix lean more to be wiki * fix: Coming soon * fix: hero image style * feat: init attribute set * fix: icons for newsposts * fix: shiki error with curl not existing * fix: formatting in footer * chore: updated nix * feat: updated packages * feat: formatted and fix some issues on nixos * feat: node and footer formatting * feat: new footer What is left of the footer is replacing the icon but I will do that later. * fix: pages * feat: polices page * chore: added a redirect to main website for now for TeaMC I did because I haven't made the TeaMC page yet but I will once I get a chance. * fix: astro check * fix: news post --------- Co-authored-by: DuckeyDev <[email protected]> Co-authored-by: Coffee-Nerd <[email protected]>
TeaClientMC · Nov 3, 2024 · 4ded58b · 4ded58b
1 parent 0742fd0
commit 4ded58b
Show file tree

Hide file tree

Showing 75 changed files with 1,525 additions and 1,459 deletions.
diff --git a/.envrc b/.envrc
@@ -1 +1 @@
-use flake . --impure
+use flake .
diff --git a/.github/workflows/PrQuality.yml b/.github/workflows/PrQuality.yml
@@ -2,27 +2,37 @@ name: Pull Request Quality
 
 on:
   pull_request:
+    branches: [main]
+    types: [opened, synchronize, reopened]
   workflow_dispatch:
 
 jobs:
-  Quality:
+  quality:
+    name: Quality
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Setup Biome
-        uses: biomejs/setup-biome@v2
-        with:
-          version: latest
-      - name: Run Biome
-        run: biome ci . --reporter=github
-
+      - uses: actions/checkout@v4
       - uses: oven-sh/setup-bun@v1
         with:
           bun-version: latest
-
       - name: Install Deps
         run: bun install
-
-      - name: Check Quality
-        run: bun check
+      - name: Check Formatting
+        run: bunx dprint check
+      - name: Check Astro Website for Major Issues
+        run: bunx astro check
+      - name: Post failure message
+        if: failure()
+        uses: actions/github-script@v5
+        with:
+          script: |
+            const { owner, repo } = context.repo;
+            const prNumber = context.issue.number;
+            // Constructing the URL to the logs for the current run
+            const logsUrl = `https://github.com/${owner}/${repo}/actions/runs/${context.runId}`;
+            await github.rest.issues.createComment({
+              owner,
+              repo,
+              issue_number: prNumber,
+              body: `The quality check has failed. Please review the changes.\n\n[View Logs](${logsUrl})`,
+            });
diff --git a/.github/workflows/Quality.yml b/.github/workflows/Quality.yml
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -1,42 +1,38 @@
-# DO NOT TOUCH THIS FILE
-# Please speak to SudoVanilla (Korbs) if you have any issues.
-# For Security check please contact Eveeifyeve Instead of sudovanilla.
-
 name: Deploy Website
 
 on:
- push:
-  branches:
-   - main
- workflow_dispatch:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
 
 env:
- # Use docker.io for Docker Hub if empty
- REGISTRY: ghcr.io
- # github.repository as <account>/<repo>
- IMAGE_NAME: ${{ github.repository }}
+  # Use docker.io for Docker Hub if empty
+  REGISTRY: ghcr.io
+  # github.repository as <account>/<repo>
+  IMAGE_NAME: ${{ github.repository }}
 
 jobs:
- build:
+  build:
     name: Building
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - name: Install, build, and upload your site
         uses: withastro/action@v2
         with:
-         package-manager:  bun@latest    
- deploy: 
-   name: Deploying to GH Pages
-   needs: build
-   runs-on: ubuntu-latest
-   permissions: 
-    pages: write
-    id-token: write
-   environment:
-    name: github-pages
-    url: ${{ steps.deployment.outputs.page_url }}
-   steps: 
-     - name: Deploy to GitHub Pages
-       id: deployment
-       uses: actions/deploy-pages@v4
+          package-manager: bun@latest
+  deploy:
+    name: Deploying to GH Pages
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/.gitignore b/.gitignore
@@ -1,24 +1,19 @@
-# build output
 dist/
-# generated types
 .astro/
 
 # dependencies
 node_modules/
 
-# logs
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-pnpm-debug.log*
-
-
 # environment variables
 .env
-.env.production
+.env.*
+!.env.example
+
+# lock files
 bun.lockb
-yarn.lock
 package-lock.json
+pnpm-lock.yaml
+yarn.lock
 
 # macOS-specific files
 .DS_Store
@@ -29,5 +24,4 @@ package-lock.json
 /playwright/.cache/
 
 # Nix stuff
-.direnv
-.devenv
+.direnv
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -1,3 +1,8 @@
 {
-	"recommendations": ["astro-build.astro-vscode", "biomejs.biome"]
+  "recommendations": [
+    "astro-build.astro-vscode",
+    "dprint.dprint",
+    "unifiedjs.vscode-mdx",
+    "bradlc.vscode-tailwindcss"
+  ]
 }
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -1,11 +1,11 @@
 {
-	"version": "0.2.0",
-	"configurations": [
-		{
-			"command": "./node_modules/.bin/astro dev",
-			"name": "Development server",
-			"request": "launch",
-			"type": "node-terminal"
-		}
-	]
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "./node_modules/.bin/astro dev",
+      "name": "Development server",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,12 +1,12 @@
 {
-	"files.exclude": {
-		"**/.git": true,
-		"**/.svn": true,
-		"**/.hg": true,
-		"**/CVS": true,
-		"**/.DS_Store": true,
-		"**/Thumbs.db": true
-	},
-	"git-blame.gitWebUrl": "",
-	"IDX.aI.enableInlineCompletion": true
+  "files.exclude": {
+    "**/.git": true,
+    "**/.svn": true,
+    "**/.hg": true,
+    "**/CVS": true,
+    "**/.DS_Store": true,
+    "**/Thumbs.db": true
+  },
+  "git-blame.gitWebUrl": "",
+  "IDX.aI.enableInlineCompletion": true
 }
diff --git a/README.md b/README.md
@@ -3,18 +3,17 @@
 <h3>TeaClient Offical Website</h3>
 <p>A website for an open-sourced client</p>
 
-
 [![Stars](https://img.shields.io/github/stars/teaclientmc/website?style=for-the-badge&logo=starship&color=7d1fdb&logoColor=D9E0EE&labelColor=573422)](https://github.com/TeaClientMC/Website/pulls)
 [![Issues](https://img.shields.io/github/issues/teaclientmc/website?style=for-the-badge&logo=gitbook&color=7d1fdb&logoColor=D9E0EE&labelColor=573422)](https://github.com/TeaClientMC/Website/issues)
 [![Deployment](https://img.shields.io/github/actions/workflow/status/teaclientmc/website/deploy.yml?style=for-the-badge&logo=github&color=7d1fdb&logoColor=D9E0EE&labelColor=573422)](https://github.com/teaclientmc/website/actions)
+
 </div>
 
 <img src="https://raw.githubusercontent.com/TeaclientMinecraft/.github/main/assets/dividers.png" alt="divider">
 
-
-
 # Features
-- News Articles 
+
+- News Articles
 - Tempaltes with Layouts
 - Uses frameworks that you love like Astro & Tailwind.
 
@@ -25,12 +24,11 @@
   - [👀 Want to learn more?](#-want-to-learn-more)
 - [Licence](#licence)
 
-
 <img src="https://raw.githubusercontent.com/TeaclientMinecraft/.github/main/assets/dividers.png" alt="divider">
 
 ## 👀 Want to learn more?
 
-Feel free to check [our documentation](https://docs.teaclient.net)
+Feel free to check [our wiki](https://teaclient.net/wiki)
 
 <img src="https://raw.githubusercontent.com/TeaclientMinecraft/.github/main/assets/dividers.png" alt="divider">
 

diff --git a/astro.config.ts b/astro.config.ts
@@ -2,18 +2,19 @@ import mdx from "@astrojs/mdx";
 import sitemap from "@astrojs/sitemap";
 import tailwind from "@astrojs/tailwind";
 import metaTags from "astro-meta-tags";
+import icon from "astro-icon";
 import { defineConfig } from "astro/config";
+import starlight from "@astrojs/starlight";
 
-import pageInsight from "astro-page-insight";
+const site = "https://teaclient.net";
 
 // https://astro.build/config
 export default defineConfig({
-	site: "https://teaclient.net",
+	site: site,
 	server: {
 		port: 7053,
 	},
 	integrations: [
-		mdx(),
 		metaTags(),
 		sitemap({
 			filter: (page) =>
@@ -24,26 +25,60 @@ export default defineConfig({
 			nesting: true,
 			applyBaseStyles: true,
 		}),
-		pageInsight(),
+		starlight({
+			title: "TeaClient",
+			disable404Route: true,
+			tableOfContents: true,
+			lastUpdated: true,
+			favicon: "/Favicon.png",
+			logo: {
+				src: "./public/icon.webp",
+			},
+			social: {
+				discord: site + "/discord",
+				github: site + "/github",
+			},
+			customCss: ["./src/styles/starlight.css"],
+			sidebar: [
+				{
+					label: "Home",
+					link: "wiki/index",
+				},
+				{
+					label: "Players",
+					autogenerate: {
+						directory: "wiki/players",
+						collapsed: false,
+					},
+				},
+				{
+					label: "Developers",
+					autogenerate: {
+						directory: "wiki/developers",
+						collapsed: true,
+					},
+				},
+			],
+			editLink: {
+				baseUrl: "https://github.com/teaclientmc/website",
+			},
+		}),
+		mdx(),
+		icon(),
 	],
 	redirects: {
-		// Resources
 		"/discord": "https://discord.gg/ejFTe4Hfnc",
 		"/github": "https://github.com/TeaClientMC",
 		"/roadmap": "https://github.com/orgs/TeaClientMC/projects/3",
-		// Partner Networks
 		"/dropps": "https://discord.gg/qFarXHT32J",
-		// Easter-Eggs
 		"/klaas": "https://klaas.tiiny.site/",
+		"/readme": "https://github.com/TeaClientMC/.github",
+		"/configSchema.json": "https://api.teaclient.net/config-schema",
 	},
 	vite: {
 		resolve: {
 			alias: {
-				"@layout": "src/layouts",
-				"@component": "src/components",
-				"@scripts": "src/scripts",
-				"@styles": "src/styles",
-				"@assets": "src/assets",
+				"@": "src/",
 			},
 		},
 		build: {