Docusaurus support

Author: codefl0w

.github/workflows/pages.yml

@@ -0,0 +1,72 @@
+name: Build and deploy Pages
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.3"
+          bundler-cache: true
+
+      - name: Build Jekyll site
+        run: bundle exec jekyll build --destination _site
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: npm
+
+      - name: Install docs dependencies
+        run: npm ci
+
+      - name: Build Docusaurus docs
+        run: npm run build
+
+      - name: Merge docs into Pages artifact
+        shell: bash
+        run: |
+          rm -rf _site/docs
+          mkdir -p _site/docs
+          cp -R build/. _site/docs/
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: _site
+
+  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@v4

.gitignore

@@ -8,3 +8,6 @@ _site/
 # Ignore folders generated by Bundler
 .bundle/
 vendor/
+node_modules/
+.docusaurus/
+build/

README.md

@@ -1,3 +1,3 @@
 # fl0w's Archive
 
-Personal portfolio / archive consisting of guides, tools, flashables and more. Mainly focused on Android.
+Personal portfolio / archive consisting of docs, tools, flashables and more. Mainly focused on Android.

_config.yml

@@ -4,3 +4,8 @@ url: "https://codefl0w.xyz"
 baseurl: ""
 author: "fl0w"
 image: "/assets/img/site/favicon.ico"
+exclude:
+  - docs
+  - node_modules
+  - .docusaurus
+  - build

archive/docs/index.md

@@ -0,0 +1,7 @@
+---
+layout: default
+title: Docs
+description: "Step-by-step Android notes, tutorials, and troubleshooting docs from fl0w."
+---
+
+<p>This page will contain useful resources related to docs.</p>

archive/guides/index.md

@@ -1,33 +1,33 @@
 ---
 layout: default
 title: fl0w's Archive
-description: "Central archive of Android tooling, guides, projects, downloads, and web utilities by fl0w."
+description: "Central archive of Android tooling, docs, projects, downloads, and web utilities by fl0w."
 ---
 
 <!-- Row 1 -->
 <div class="dashboard">
   <a class="card" href="/archive/android-tools">
-    <h2>🔧 Android Tools</h2>
+    <h2>Android Tools</h2>
     <p>Scripts, tools, and tricks for Android hacking.</p>
   </a>
-  <a class="card" href="/archive/guides">
-    <h2>📘 Guides</h2>
-    <p>Notes, tutorials, and step-by-step guides.</p>
+  <a class="card" href="/archive/docs">
+    <h2>Docs</h2>
+    <p>Notes, tutorials, and step-by-step docs.</p>
   </a>
   <a class="card" href="/archive/projects">
-    <h2>📂 Projects</h2>
+    <h2>Projects</h2>
     <p>My personal software and dev experiments.</p>
   </a>
   <a class="card" href="/archive/downloads">
-    <h2>📌 Downloads</h2>
+    <h2>Downloads</h2>
     <p>Tool dumps, flashables, and firmware images.</p>
   </a>
 </div>
 
 <!-- Row 2 -->
 <div class="dashboard">
   <a class="card" href="/archive/web-tools">
-    <h2>🌐 Web Tools</h2>
+    <h2>Web Tools</h2>
     <p>Web tools to handle simple tasks.</p>
-  </a> 
+  </a>
 </div>

archive/index.md

@@ -0,0 +1,13 @@
+---
+sidebar_position: 1
+title: Intro
+slug: /
+---
+
+# fl0w Docs
+
+This directory is prepared for Docusaurus-based documentation.
+
+Use it for Android notes, chipset research, tooling docs, and longer-form technical writeups.
+
+The current Jekyll archive docs page remains available at `/archive/docs`.

docs/intro.md

@@ -0,0 +1,83 @@
+const config = {
+  title: "fl0w Docs",
+  tagline: "Android notes, docs, and documentation",
+  favicon: "assets/img/site/favicon.ico",
+  url: "https://codefl0w.xyz",
+  baseUrl: "/docs/",
+  organizationName: "codefl0w",
+  projectName: "codefl0w.github.io",
+  onBrokenLinks: "warn",
+  markdown: {
+    hooks: {
+      onBrokenMarkdownLinks: "warn"
+    }
+  },
+  i18n: {
+    defaultLocale: "en",
+    locales: ["en"]
+  },
+  presets: [
+    [
+      "classic",
+      {
+        docs: {
+          path: "docs",
+          routeBasePath: "/",
+          sidebarPath: require.resolve("./sidebars.js")
+        },
+        blog: false,
+        theme: {
+          customCss: require.resolve("./assets/css/style.css")
+        }
+      }
+    ]
+  ],
+  themeConfig: {
+    navbar: {
+      title: "fl0w Docs",
+      items: [
+        {
+          to: "/",
+          label: "Docs",
+          position: "left"
+        },
+        {
+          href: "https://codefl0w.xyz/archive/docs",
+          label: "Archive Docs",
+          position: "left"
+        },
+        {
+          href: "https://github.com/codefl0w",
+          label: "GitHub",
+          position: "right"
+        }
+      ]
+    },
+    footer: {
+      style: "dark",
+      links: [
+        {
+          title: "Docs",
+          items: [
+            {
+              label: "Intro",
+              to: "/"
+            }
+          ]
+        },
+        {
+          title: "More",
+          items: [
+            {
+              label: "Archive",
+              href: "https://codefl0w.xyz/archive"
+            }
+          ]
+        }
+      ],
+      copyright: `Copyright ${new Date().getFullYear()} fl0w`
+    }
+  }
+};
+
+module.exports = config;