docs: transfer to carch-org (#2)

Co-authored-by: aayush <[email protected]>
Co-authored-by: Smriti Bhandari <[email protected]>

.github/workflows/docs.yml

@@ -0,0 +1,52 @@
+name: Deploy VitePress site to Pages
+
+on:
+  push:
+    branches: [main]
+
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: npm ci
+      - name: Build with VitePress
+        run: npm run docs:build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  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,112 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+vscode
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+/node_modules
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# cache
+docs/.vitepress/cache
+
+# devicon
+docs/.vitepress/devicon
+

docs/.vitepress/config.ts

@@ -0,0 +1,99 @@
+// .vitepress/config.js
+export default {
+  title: 'Carch',
+  description: 'Documentation website of carch',
+  base: "/docs/",
+  lastUpdated: true,
+
+  head: [
+        ["link", { rel: "icon", href: "/carch/package.png" }],
+    ],
+
+  themeConfig: {
+    siteTitle: "Carch",
+    logo: "package.png",
+    outline: "deep",
+    docsDir: "/docs",
+    editLink: {
+      pattern: "https://github.com/harilvfs/carch/tree/main/docs/:path",
+      text: "Edit this page on GitHub",
+    },
+    nav: [
+      { text: "Home", link: "/" },
+      { text: "Guide", link: "/getting-started/introduction" },
+      { 
+        text: "3.0.9",
+        items: [
+          {
+          text: 'Changelog',
+          link: 'https://github.com/harilvfs/carch/blob/main/CHANGELOG.md'
+          },
+        ],
+      },
+    ],
+    sidebar: [
+      {
+        text: "Getting Started",
+        collapsible: true,
+        collapsed: false,
+        items: [
+          { text: "Introduction", link: "/getting-started/introduction" },
+          { text: "Preview", link: "/getting-started/preview.md" },
+        ],
+      },
+      {
+        text: "Installation",
+        collapsible: true,
+        collapsed: false,
+        items: [
+          { text: "Terminal", link: "/installation/cli" },
+          { text: "Commands", link: "/installation/cmd" },
+          { text: "GTK", link: "/installation/gtk" },
+          { text: "Arch [AUR]", link: "/installation/aur" },
+        ],
+      },
+      {
+        text: "Utilities",
+        collapsible: true,
+        collapsed: false,
+        items: [
+          { text: "Overview Scripts", link: "/scripts/scripts" },
+        ],
+      },
+      {
+        text: "Collaboration",
+        collapsible: true,
+        collapsed: false,
+        items: [
+          { text: "Roadmap", link: "/github/roadmap" },
+          { text: "Contributing", link: "/github/contributing" },
+          { text: "Code of Conduct", link: "/github/codeofconduct" },
+        ],
+      },
+     {
+        text: "Acknowledgment",
+        collapsible: true,
+        collapsed: false,
+        items: [
+          { text: "Inspiration", link: "/acknowledgment/inspiration" },
+          { text: "Contributions", link: "/acknowledgment/contributors" },
+        ],
+      },
+    ],
+    socialLinks: [
+      { icon: "telegram", link: "https://t.me/harilvfs" },
+      { icon: "discord", link: "https://discord.com/invite/8NJWstnUHd" },
+      { icon: "gmail", link: "mailto:[email protected]" },
+    ],
+    footer: {
+      message: "Released under the GPL-3.0 License.",
+      copyright: "Copyright © 2024 Hari Chalise",
+    },
+    search: {
+      provider: "local",
+      },
+    returnToTopLabel: 'Go to Top',
+    sidebarMenuLabel: 'Menu',
+    },
+};
+

docs/.vitepress/theme/custom.css

@@ -0,0 +1,128 @@
+
+/**
+ * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
+ */
+
+.VPNavBar .VPNavBarTitle span {
+    font-size: 1.2em;
+    font-weight: bold;
+    background: linear-gradient(120deg, var(--vp-c-brand-3), var(--vp-c-brand-1));
+    -webkit-background-clip: text;
+    -webkit-text-fill-color: transparent;
+    background-clip: text;
+    color: transparent;
+}
+
+:root {
+    --vp-c-gray-1: #dddde3;
+    --vp-c-gray-2: #e4e4e9;
+    --vp-c-gray-3: #ebebef;
+    --vp-c-gray-soft: rgba(142, 150, 170, 0.14);
+
+    --vp-c-indigo-1: #3451b2;
+    --vp-c-indigo-2: #3a5ccc;
+    --vp-c-indigo-3: #5672cd;
+    --vp-c-indigo-soft: rgba(100, 108, 255, 0.14);
+
+    --vp-c-purple-1: #6f42c1;
+    --vp-c-purple-2: #7e4cc9;
+    --vp-c-purple-3: #8e5cd9;
+    --vp-c-purple-soft: rgba(159, 122, 234, 0.14);
+
+    --vp-c-green-1: #18794e;
+    --vp-c-green-2: #299764;
+    --vp-c-green-3: #30a46c;
+    --vp-c-green-soft: rgba(16, 185, 129, 0.14);
+
+    --vp-c-yellow-1: #915930;
+    --vp-c-yellow-2: #946300;
+    --vp-c-yellow-3: #9f6a00;
+    --vp-c-yellow-soft: rgba(234, 179, 8, 0.14);
+
+    --vp-c-red-1: #b8272c;
+    --vp-c-red-2: #d5393e;
+    --vp-c-red-3: #e0575b;
+    --vp-c-red-soft: rgba(244, 63, 94, 0.14);
+
+    --vp-c-sponsor: #db2777;
+}
+
+.dark {
+    --vp-c-gray-1: #515151;
+    --vp-c-gray-2: #464646;
+    --vp-c-gray-3: #323232;
+    --vp-c-gray-soft: hsla(0, 0%, 36%, 0.16);
+
+    --vp-c-indigo-1: hsl(207, 76%, 61%);
+    --vp-c-indigo-2: hsl(207, 86%, 51%);
+    --vp-c-indigo-3: hsl(207, 96%, 41%);
+    --vp-c-indigo-soft: hsla(207, 76%, 61%, .18);
+
+    --vp-c-purple-1: #c8abfa;
+    --vp-c-purple-2: #a879e6;
+    --vp-c-purple-3: #8e5cd9;
+    --vp-c-purple-soft: rgba(159, 122, 234, 0.16);
+
+    --vp-c-green-1: hsl(158, 100%, 42%);
+    --vp-c-green-2: hsl(158, 95%, 37%);
+    --vp-c-green-3: hsl(158, 90%, 35%);
+    --vp-c-green-soft: hsla(158, 100%, 42%, 0.16);
+
+    --vp-c-yellow-1: #f9b44e;
+    --vp-c-yellow-2: #da8b17;
+    --vp-c-yellow-3: #a46a0a;
+    --vp-c-yellow-soft: rgba(234, 179, 8, 0.16);
+
+    --vp-c-red-1: #f66f81;
+    --vp-c-red-2: #f14158;
+    --vp-c-red-3: #b62a3c;
+    --vp-c-red-soft: rgba(244, 63, 94, 0.16);
+}
+
+/* ---------- *
+ * Background *
+ * ---------- */
+
+:root {
+    --vp-c-bg: #ffffff;
+    --vp-c-bg-alt: #f6f6f7;
+    --vp-c-bg-elv: #ffffff;
+    --vp-c-bg-soft: #f6f6f7;
+}
+
+.dark {
+    --vp-c-bg: #111111;
+    --vp-c-bg-alt: #181818;
+    --vp-c-bg-elv: #202122;
+    --vp-c-bg-soft: #202122;
+}
+
+/** Borders */
+:root {
+    --vp-c-border: #c2c2c4;
+    --vp-c-divider: #e2e2e3;
+    --vp-c-gutter: #e2e2e3;
+}
+
+.dark {
+    --vp-c-border: #3c3d3e;
+    --vp-c-divider: #2e2e2e;
+    --vp-c-gutter: #000000;
+}
+
+/* ---- *
+ * Text *
+ * ---- */
+
+:root {
+    --vp-c-text-1: rgba(60, 60, 67);
+    --vp-c-text-2: rgba(60, 60, 67, 0.78);
+    --vp-c-text-3: rgba(60, 60, 67, 0.56);
+}
+
+.dark {
+    --vp-c-text-1: rgba(255, 255, 245, 0.86);
+    --vp-c-text-2: rgba(235, 235, 245, 0.6);
+    --vp-c-text-3: rgba(235, 235, 245, 0.38);
+}
+