| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
0 parents commit e9c1244
8 files changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,62 @@ | |||
| 1 | + # Sample workflow for building and deploying a VitePress site to GitHub Pages | ||
| 2 | + # | ||
| 3 | + name: Deploy VitePress site to Pages | ||
| 4 | + | ||
| 5 | + on: | ||
| 6 | + # Runs on pushes targeting the `main` branch. Change this to `master` if you're | ||
| 7 | + # using the `master` branch as the default branch. | ||
| 8 | + push: | ||
| 9 | + branches: [main] | ||
| 10 | + | ||
| 11 | + # Allows you to run this workflow manually from the Actions tab | ||
| 12 | + workflow_dispatch: | ||
| 13 | + | ||
| 14 | + # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
| 15 | + permissions: | ||
| 16 | + contents: read | ||
| 17 | + pages: write | ||
| 18 | + id-token: write | ||
| 19 | + | ||
| 20 | + # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
| 21 | + # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||
| 22 | + concurrency: | ||
| 23 | + group: pages | ||
| 24 | + cancel-in-progress: false | ||
| 25 | + | ||
| 26 | + jobs: | ||
| 27 | + # Build job | ||
| 28 | + build: | ||
| 29 | + runs-on: ubuntu-latest | ||
| 30 | + steps: | ||
| 31 | + - name: Checkout | ||
| 32 | + uses: actions/checkout@v4 | ||
| 33 | + with: | ||
| 34 | + fetch-depth: 0 | ||
| 35 | + - name: Setup Node | ||
| 36 | + uses: actions/setup-node@v4 | ||
| 37 | + with: | ||
| 38 | + node-version: 22 | ||
| 39 | + cache: npm | ||
| 40 | + - name: Setup Pages | ||
| 41 | + uses: actions/configure-pages@v4 | ||
| 42 | + - name: Install dependencies | ||
| 43 | + run: npm ci | ||
| 44 | + - name: Build with VitePress | ||
| 45 | + run: npm run docs:build | ||
| 46 | + - name: Upload artifact | ||
| 47 | + uses: actions/upload-pages-artifact@v3 | ||
| 48 | + with: | ||
| 49 | + path: .vitepress/dist | ||
| 50 | + | ||
| 51 | + # Deployment job | ||
| 52 | + deploy: | ||
| 53 | + environment: | ||
| 54 | + name: github-pages | ||
| 55 | + url: ${{ steps.deployment.outputs.page_url }} | ||
| 56 | + needs: build | ||
| 57 | + runs-on: ubuntu-latest | ||
| 58 | + name: Deploy | ||
| 59 | + steps: | ||
| 60 | + - name: Deploy to GitHub Pages | ||
| 61 | + id: deployment | ||
| 62 | + uses: actions/deploy-pages@v4 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,3 @@ | |||
| 1 | + node_modules/ | ||
| 2 | + .vitepress/cache/ | ||
| 3 | + .vitepress/dist/ | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,30 @@ | |||
| 1 | + import { defineConfig } from 'vitepress' | ||
| 2 | + | ||
| 3 | + // https://vitepress.dev/reference/site-config | ||
| 4 | + export default defineConfig({ | ||
| 5 | + title: "aa-proxy Docs", | ||
| 6 | + description: "Docs for aa-proxy", | ||
| 7 | + base: '/docs/', | ||
| 8 | + cleanUrls: true, | ||
| 9 | + themeConfig: { | ||
| 10 | + // https://vitepress.dev/reference/default-theme-config | ||
| 11 | + nav: [ | ||
| 12 | + { text: 'Home', link: '/' }, | ||
| 13 | + { text: 'Examples', link: '/markdown-examples' } | ||
| 14 | + ], | ||
| 15 | + | ||
| 16 | + sidebar: [ | ||
| 17 | + { | ||
| 18 | + text: 'Examples', | ||
| 19 | + items: [ | ||
| 20 | + { text: 'Markdown Examples', link: '/markdown-examples' }, | ||
| 21 | + { text: 'Runtime API Examples', link: '/api-examples' } | ||
| 22 | + ] | ||
| 23 | + } | ||
| 24 | + ], | ||
| 25 | + | ||
| 26 | + socialLinks: [ | ||
| 27 | + { icon: 'github', link: 'https://github.com/aa-proxy/aa-proxy-rs' } | ||
| 28 | + ] | ||
| 29 | + } | ||
| 30 | + }) | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,49 @@ | |||
| 1 | + --- | ||
| 2 | + outline: deep | ||
| 3 | + --- | ||
| 4 | + | ||
| 5 | + # Runtime API Examples | ||
| 6 | + | ||
| 7 | + This page demonstrates usage of some of the runtime APIs provided by VitePress. | ||
| 8 | + | ||
| 9 | + The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files: | ||
| 10 | + | ||
| 11 | + ```md | ||
| 12 | + <script setup> | ||
| 13 | + import { useData } from 'vitepress' | ||
| 14 | + | ||
| 15 | + const { theme, page, frontmatter } = useData() | ||
| 16 | + </script> | ||
| 17 | + | ||
| 18 | + ## Results | ||
| 19 | + | ||
| 20 | + ### Theme Data | ||
| 21 | + <pre>{{ theme }}</pre> | ||
| 22 | + | ||
| 23 | + ### Page Data | ||
| 24 | + <pre>{{ page }}</pre> | ||
| 25 | + | ||
| 26 | + ### Page Frontmatter | ||
| 27 | + <pre>{{ frontmatter }}</pre> | ||
| 28 | + ``` | ||
| 29 | + | ||
| 30 | + <script setup> | ||
| 31 | + import { useData } from 'vitepress' | ||
| 32 | + | ||
| 33 | + const { site, theme, page, frontmatter } = useData() | ||
| 34 | + </script> | ||
| 35 | + | ||
| 36 | + ## Results | ||
| 37 | + | ||
| 38 | + ### Theme Data | ||
| 39 | + <pre>{{ theme }}</pre> | ||
| 40 | + | ||
| 41 | + ### Page Data | ||
| 42 | + <pre>{{ page }}</pre> | ||
| 43 | + | ||
| 44 | + ### Page Frontmatter | ||
| 45 | + <pre>{{ frontmatter }}</pre> | ||
| 46 | + | ||
| 47 | + ## More | ||
| 48 | + | ||
| 49 | + Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata). | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,25 @@ | |||
| 1 | + --- | ||
| 2 | + # https://vitepress.dev/reference/default-theme-home-page | ||
| 3 | + layout: home | ||
| 4 | + | ||
| 5 | + hero: | ||
| 6 | + name: "aa-proxy-docs" | ||
| 7 | + text: "Docs for aa-proxy" | ||
| 8 | + tagline: My great project tagline | ||
| 9 | + actions: | ||
| 10 | + - theme: brand | ||
| 11 | + text: Markdown Examples | ||
| 12 | + link: /markdown-examples | ||
| 13 | + - theme: alt | ||
| 14 | + text: API Examples | ||
| 15 | + link: /api-examples | ||
| 16 | + | ||
| 17 | + features: | ||
| 18 | + - title: Feature A | ||
| 19 | + details: Lorem ipsum dolor sit amet, consectetur adipiscing elit | ||
| 20 | + - title: Feature B | ||
| 21 | + details: Lorem ipsum dolor sit amet, consectetur adipiscing elit | ||
| 22 | + - title: Feature C | ||
| 23 | + details: Lorem ipsum dolor sit amet, consectetur adipiscing elit | ||
| 24 | + --- | ||
| 25 | + | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,85 @@ | |||
| 1 | + # Markdown Extension Examples | ||
| 2 | + | ||
| 3 | + This page demonstrates some of the built-in markdown extensions provided by VitePress. | ||
| 4 | + | ||
| 5 | + ## Syntax Highlighting | ||
| 6 | + | ||
| 7 | + VitePress provides Syntax Highlighting powered by [Shiki](https://github.com/shikijs/shiki), with additional features like line-highlighting: | ||
| 8 | + | ||
| 9 | + **Input** | ||
| 10 | + | ||
| 11 | + ````md | ||
| 12 | + ```js{4} | ||
| 13 | + export default { | ||
| 14 | + data () { | ||
| 15 | + return { | ||
| 16 | + msg: 'Highlighted!' | ||
| 17 | + } | ||
| 18 | + } | ||
| 19 | + } | ||
| 20 | + ``` | ||
| 21 | + ```` | ||
| 22 | + | ||
| 23 | + **Output** | ||
| 24 | + | ||
| 25 | + ```js{4} | ||
| 26 | + export default { | ||
| 27 | + data () { | ||
| 28 | + return { | ||
| 29 | + msg: 'Highlighted!' | ||
| 30 | + } | ||
| 31 | + } | ||
| 32 | + } | ||
| 33 | + ``` | ||
| 34 | + | ||
| 35 | + ## Custom Containers | ||
| 36 | + | ||
| 37 | + **Input** | ||
| 38 | + | ||
| 39 | + ```md | ||
| 40 | + ::: info | ||
| 41 | + This is an info box. | ||
| 42 | + ::: | ||
| 43 | + | ||
| 44 | + ::: tip | ||
| 45 | + This is a tip. | ||
| 46 | + ::: | ||
| 47 | + | ||
| 48 | + ::: warning | ||
| 49 | + This is a warning. | ||
| 50 | + ::: | ||
| 51 | + | ||
| 52 | + ::: danger | ||
| 53 | + This is a dangerous warning. | ||
| 54 | + ::: | ||
| 55 | + | ||
| 56 | + ::: details | ||
| 57 | + This is a details block. | ||
| 58 | + ::: | ||
| 59 | + ``` | ||
| 60 | + | ||
| 61 | + **Output** | ||
| 62 | + | ||
| 63 | + ::: info | ||
| 64 | + This is an info box. | ||
| 65 | + ::: | ||
| 66 | + | ||
| 67 | + ::: tip | ||
| 68 | + This is a tip. | ||
| 69 | + ::: | ||
| 70 | + | ||
| 71 | + ::: warning | ||
| 72 | + This is a warning. | ||
| 73 | + ::: | ||
| 74 | + | ||
| 75 | + ::: danger | ||
| 76 | + This is a dangerous warning. | ||
| 77 | + ::: | ||
| 78 | + | ||
| 79 | + ::: details | ||
| 80 | + This is a details block. | ||
| 81 | + ::: | ||
| 82 | + | ||
| 83 | + ## More | ||
| 84 | + | ||
| 85 | + Check out the documentation for the [full list of markdown extensions](https://vitepress.dev/guide/markdown). | ||
| Back | FazBrowse Home | New Git URL |
0 commit comments