[#1] revamp

Author: joanjeremiah

.github/workflows/deploy.yml

@@ -0,0 +1,55 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches: ["main"]
+
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install pnpm
+        run: npm i -g pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Build
+        run: pnpm build
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          name: github-pages
+          path: ./.vitepress/dist/
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,35 +1,14 @@
 _drafts/
 _site/
-
-#OS X stuff
-.DS_Store
-# temp files
-*~
-*.swp
-/.gitk-tmp.*
-atlassian-ide-plugin.xml
-
-# ignore IDEA files
-*.iml
-*.ipr
-*.iws
-.idea
-
-# ignore Maven generated target folders
-/.m2
-~
-target
-
-# ignore eclipse files
-.project
-.classpath
-.settings
-.metadata
-.checkstyle
-.factorypath
-
-## Environment normalization:
 .env
 /.bundle
+/build
 /vendor/bundle
 /lib/bundler/man/
+.vitepress/dist
+.vitepress/cache
+node_modules
+
+# Allow only pnpm lock file
+*lock*
+!pnpm-lock.yaml

.npmrc

@@ -0,0 +1 @@
+auto-install-peers=true

.prettierrc

@@ -0,0 +1,9 @@
+{
+    "printWidth": 80,
+    "semi": true,
+    "singleQuote": false,
+    "trailingComma": "es5",
+    "bracketSameLine": true,
+    "useTabs": false,
+    "tabWidth": 3
+}

.vitepress/config.mts

@@ -0,0 +1,44 @@
+import { defineConfig } from "vitepress";
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+   title: "AGROAL",
+   description: "Documentation website for Agroal",
+   themeConfig: {
+      // https://vitepress.dev/reference/default-theme-config
+      nav: [
+         { text: "News", link: "/news" },
+         { text: "Releases", link: "/releases" },
+         { text: "Docs", link: "/docs.md" },
+         { text: "About", link: "/about.md" },
+      ],
+
+      footer: {
+         message:
+            "<span class='vp-doc'></span>",
+         copyright:
+            "© 2017/2024 <a href='https://www.redhat.com/en'>RedHat Inc</a>.",
+      },
+
+      sidebar: [
+         {
+            text: "Home",
+            link: "/"
+         },
+         {
+            text: "GitHub",
+            link: "https://github.com/agroal",
+         },
+         {
+            text: "License",
+            link: "https://www.apache.org/licenses/LICENSE-2.0",
+         },
+         {
+            text: "Issues",
+            link: "https://issues.redhat.com/projects/AG/issues",
+         },
+      ],
+
+      socialLinks: [{ icon: "github", link: "https://github.com/agroal" }],
+   },
+});