init

Author: xueqidove

.github/workflows/jekyll-gh-pages.yml

@@ -0,0 +1,69 @@
+name: Deploy Docs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - master
+  workflow_dispatch: {}
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: Build static docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+          cache: 'npm'
+          cache-dependency-path: docs/package-lock.json
+
+      - name: Install dependencies
+        working-directory: docs
+        run: npm ci
+
+      - name: Build Next.js site
+        working-directory: docs
+        run: npm run build
+
+      - name: Add .nojekyll
+        run: |
+          touch docs/out/.nojekyll
+
+      - name: Copy CNAME if present
+        if: ${{ hashFiles('CNAME') != '' }}
+        run: |
+          mkdir -p docs/out
+          cp CNAME docs/out/CNAME
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/out
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy to GitHub Pages
+    steps:
+      - name: Deploy
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,5 @@
+node_modules
+docs/node_modules
+docs/.next
+out
+

CNAME

@@ -0,0 +1 @@
+whitepaper.jumpserver.org

LICENSE

@@ -0,0 +1,2 @@
+# whitepaper.github.io
+JumpServer whitepaper

README.md

@@ -0,0 +1,16 @@
+# Nextra Docs Site
+
+This folder contains a Nextra (Next.js) docs site that restructures the Word-exported whitepaper into clean MDX pages with a left sidebar.
+
+Quick start
+
+- Install: `npm i`
+- Dev: `npm run dev` → http://localhost:3000
+- Build: `npm run build && npm start`
+
+Content
+
+- Pages live under `pages/` as `.mdx` files.
+- Sidebar is defined by `pages/_meta.json`.
+- Images should be placed in `public/whitepaper/` and referenced as `/whitepaper/<file>`.
+

docs/README.md

@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/pages/building-your-application/configuring/typescript for more information.

docs/next-env.d.ts

@@ -0,0 +1,14 @@
+import nextra from 'nextra'
+
+const withNextra = nextra({
+  theme: 'nextra-theme-docs',
+  themeConfig: './theme.config.tsx',
+})
+
+export default withNextra({
+  reactStrictMode: true,
+  output: 'export',
+  images: {
+    unoptimized: true
+  }
+})