Merge pull request #24 from Imzxhir/main

Switch to Starlight

.github/workflows/deploy.yml

@@ -1,23 +1,34 @@
-name: Deploy the Docs
+name: Deploy to GitHub Pages
+
 on:
  push:
- branches:
- - main
+ branches: [ main ]
+ workflow_dispatch:
+
 permissions:
- contents: write
+ contents: read
+ pages: write
+ id-token: write
+
 jobs:
- deploy:
+ build:
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v4
- - uses: actions/setup-python@v4
- with:
- python-version: 3.x
- - uses: actions/cache@v3
+ - name: Checkout your repository using git
+ uses: actions/checkout@v3
+ - name: Install, build, and upload your site
+ uses: withastro/action@v1
  with:
- key: ${{ github.ref }}
- path: .cache
- - run: pip install mkdocs-material
- - run: pip install mkdocs-glightbox
- - run: git pull
- - run: mkdocs gh-deploy -f config/en/mkdocs.yml
+ node-version: 18
+ package-manager: pnpm@latest
+
+ deploy:
+ needs: build
+ runs-on: ubuntu-latest
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
+ steps:
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/deploy-pages@v1

.gitignore

@@ -3,6 +3,23 @@
 /.vscode
 /.vs
 
+# Build Files
+/dist
+
+# Dependency directories
+/.astro
+/node_modules
+
+# Logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# Environment Variables
+.env
+.env.production
+
 #OSX Stuff
 .DS_Store
 .DS_Store?

README.md

@@ -2,7 +2,7 @@
 
 ## Welcome to the SideStore wiki's source repo!
 
-The wiki itself can be found at https://wiki.sidestore.io/.
+The wiki itself can be found at <https://wiki.sidestore.io/>.
 
 ## Status
 

astro.config.mjs

@@ -0,0 +1,49 @@
+import { defineConfig } from 'astro/config';
+import starlight from '@astrojs/starlight';
+
+export default defineConfig({
+ site: 'https://wiki.sidestore.io',
+ integrations: [
+ starlight({
+ title: 'SideStore Docs',
+ logo: {
+ alt: 'SideStore Logo',
+ src: '/src/assets/icons/sidestore-icon.png',
+ replacesTitle: false,
+ },
+ favicon: '/favicon.svg',
+ social: {
+ github: 'https://github.com/sidestore',
+ discord: 'https://discord.gg/sidestore-949183273383395328',
+ twitter: 'https://twitter.com/sidestore_io'
+ },
+ customCss: [
+ './src/styles/custom.css',
+ ],
+ sidebar: [
+ {
+ label: 'FAQ',
+ link: 'faq',
+ },
+ {
+ label: 'Guides',
+ items: [
+ { label: 'Getting Started', link: '/guides/getting-started/' },
+ { label: 'Create a Burner Apple ID', link: '/guides/burner-apple-id/' },
+ { label: 'Troubleshooting', link: '/guides/troubleshooting/' },
+ { label: 'Error Codes', link: '/guides/error-codes/' },
+ ],
+ },
+ {
+ label: 'Advanced',
+ items: [
+ { label: 'Custom Anisette Server', link: '/advanced/anisette-server/' },
+ { label: 'App Sources', link: '/advanced/app-sources/' },
+ { label: 'URL Schemes', link: '/advanced/url-schemes/' },
+ ]
+
+ },
+ ],
+ }),
+ ],
+});