customize doc deployment

RichardZhu2 · RichardZhu2 · commit ab17e44d7093 · 2024-11-19T17:28:49.000Z
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
@@ -0,0 +1,48 @@
+name: Deploy Docs to GitHub Pages with Jekyll
+
+on:
+  push:
+    branches: ["main"]
+    paths:
+        - "docs/**"
+
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./docs
+          destination: ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/docs/Introduction.md b/docs/Introduction.md
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Pyper</title>
+</head>
+<body>
+    <header>
+        <h1>Welcome to Pyper</h1>
+    </header>
+    <main>
+        <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam accumsan sapien eu odio malesuada, vel posuere nunc facilisis. Morbi auctor ipsum nec eros dictum, quis pulvinar lorem pharetra.</p>
+        <p>Sed varius, lacus sit amet luctus tincidunt, sapien lacus vehicula risus, nec congue erat neque nec nunc. Integer in sagittis lectus. Aliquam erat volutpat. Aenean malesuada purus non ipsum faucibus, quis scelerisque augue ultrices.</p>
+        <p>Curabitur efficitur magna id metus ultricies, nec auctor nulla bibendum. Ut vitae justo nec arcu tincidunt facilisis.</p>
+    </main>
+    <footer>
+        <p>&copy; 2024 Richard Zhu. All rights reserved.</p>
+    </footer>
+</body>
+</html>
