vitepress

Author: previ

.github/workflows/deploy.yml

@@ -1,50 +1,65 @@
-name: Build and deploy an updated version of the website
+# Sample workflow for building and deploying a Nuxt site to GitHub Pages
+#
+# To get started with Nuxt see: https://nuxtjs.org/docs/get-started/installation
+#
+name: Build and publish docs to GitHub Pages
 
 on:
-  push
+  # Runs on pushes targeting the default branch
+  push:
+    branches: [vitepress]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
 
 jobs:
+  # Build job
   build:
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout CoderBotOrg/docs
-      uses: actions/checkout@v2
-      with:
-        repository: CoderBotOrg/docs
-        path: folder/repo
-        lfs: true 
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: "16"
+          cache: ${{ steps.detect-package-manager.outputs.manager }}
+      - name: Restore cache
+        uses: actions/cache@v3
+        with:
+          path: |
+            dist
+          key: ${{ runner.os }}-build-${{ hashFiles('dist') }}
+          restore-keys: |
+            ${{ runner.os }}-build-
+      - name: Install dependencies
+        run: npm ci
+      - name: Static HTML export with VitePress
+        run: npm run docs:build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: ./docs/.vitepress/dist
 
-    - name: Checkout CoderBotOrg/docs
-      uses: actions/checkout@v2
-      with:
-        repository: CoderBotOrg/docs
-        ref: master
-        path: folder/build
-        lfs: true
-        
-    - uses: actions/setup-node@v1
-      with:
-        node-version: '12'
-
-    - name: Install npm dependencies
-      working-directory: folder/repo/
-      run: |
-        npm install
-        
-    - working-directory: folder/
-      run: |
-        cd repo
-        npm run build
-        mkdir dist
-        cp pages/.vuepress/dist/* dist/ -r
-        cd ..
-        cp -a repo/dist/. build/
-        cd build
-        mkdir -m 700 ~/.ssh
-        echo "${{ secrets.SSH_KEY_SECRET }}" > ~/.ssh/id_ed25519
-        chmod 0600 ~/.ssh/id_ed25519
-        git config --local user.name "GitHub Action"
-        git config --global user.email "[email protected]"
-        echo "docs.coderbot.org" > CNAME
-        git add .
-        git commit -m "Update build" && git push || :
+  # 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@v1

README.md

@@ -13,65 +13,15 @@ npm install
 
 ### Deploy
 
-Start a development server with hot reload on `localhost:8080/docs/`:
-```bash
-npx vuepress dev pages/
-```
-
-Production build (destionation: `pages/.vuepress/dist`):
-```bash
-npx vuepress build pages/
-```
-
-Build and deploy on GitHub Pages: 
-
-```bash
-npm run deploy
-```
+Push to the **main** branch.
 
 ### Development
 
-```
-.
-├── pages
-│   ├── .vuepress (Optional)
-│   │   ├── components (Optional)
-│   │   ├── theme (Optional)
-│   │   │   └── Layout.vue
-│   │   ├── public (Optional)
-│   │   ├── styles (Optional)
-│   │   │   ├── index.styl
-│   │   │   └── palette.styl
-│   │   ├── templates (Optional, Danger Zone)
-│   │   │   ├── dev.html
-│   │   │   └── ssr.html
-│   │   ├── config.js (Optional)
-│   │   └── enhanceApp.js (Optional)
-│   │ 
-│   ├── README.md
-│   ├── manual
-│   │   └── README.md
-│   └── anotherpage.md
-│ 
-└── package.json
-```
-
-- `pages/.vuepress`: It is used to store global configuration, components, static resources, etc.
-- `pages/.vuepress/components`: The Vue components in this directory will be automatically registered as global components.
-- `pages/.vuepress/theme`: Used to store local theme.
-- `pages/.vuepress/styles`: Stores style related files.
-- `pages/.vuepress/styles/index.styl`: Automatically applied global style files, generated at the ending of the CSS file, have a higher priority than the default style.
-- `pages/.vuepress/styles/palette.styl`: The palette is used to override the default color constants and to set the color constants of Stylus.
-- `pages/.vuepress/public`: Static resource directory.
-- `pages/.vuepress/templates`: Store HTML template files.
-- `pages/.vuepress/templates/dev.html`: HTML template file for development environment.
-- `pages/.vuepress/templates/ssr.html`: Vue SSR based HTML template file in the built time.
-- `pages/.vuepress/config.js`: Entry file of configuration, can also be yml or toml.
-- `pages/.vuepress/enhanceApp.js`: App level enhancement.
+Install node, then run:
 
-Image assets using the $baseURL helper
-```html
-<img :src="$withBase('/foo.png')" alt="foo">
+```
+# npm i
+# npm run docs:dev
 ```
 
 ### License

docs/.vitepress/cache/deps/@theme_index.js

@@ -0,0 +1,19 @@
+{
+  "hash": "0d5dc3cb",
+  "browserHash": "d9c08748",
+  "optimized": {
+    "vue": {
+      "src": "../../../../node_modules/vue/dist/vue.runtime.esm-bundler.js",
+      "file": "vue.js",
+      "fileHash": "ad1e1095",
+      "needsInterop": false
+    },
+    "@theme/index": {
+      "src": "../../../../node_modules/vitepress/dist/client/theme-default/index.js",
+      "file": "@theme_index.js",
+      "fileHash": "dad0dd35",
+      "needsInterop": false
+    }
+  },
+  "chunks": {}
+}

docs/.vitepress/cache/deps/@theme_index.js.map

@@ -0,0 +1 @@
+{"type":"module"}