Skip to content

Commit dbb1d41

Browse files
committed
feat: add github action config
1 parent d344cb9 commit dbb1d41

File tree

8 files changed

+1117
-0
lines changed

8 files changed

+1117
-0
lines changed

.github/workflows/deploy.yml

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Sample workflow for building and deploying a VitePress site to GitHub Pages
2+
#
3+
name : Deploy Sub Store Docs
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 : [ master ]
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@v3
33+
with :
34+
fetch-depth : 0 # Not needed if lastUpdated is not enabled
35+
- uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm
36+
# - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
37+
- name : Setup Node
38+
uses : actions/setup-node@v3
39+
with :
40+
node-version : 18
41+
cache : pnpm # or pnpm / yarn
42+
- name : Setup Pages
43+
uses : actions/configure-pages@v3
44+
- name : Install dependencies
45+
run : pnpm i # or pnpm install / yarn install / bun install
46+
- name : Build with VitePress
47+
run : |
48+
pnpm docs:build
49+
touch .vitepress/dist/.nojekyll
50+
- name : Upload artifact
51+
uses : actions/upload-pages-artifact@v2
52+
with :
53+
path : .vitepress/dist
54+
55+
# Deployment job
56+
deploy :
57+
environment :
58+
name : github-pages
59+
url : ${{ steps.deployment.outputs.page_url }}
60+
needs : build
61+
runs-on : ubuntu-latest
62+
name : Deploy
63+
steps :
64+
- name : Deploy to GitHub Pages
65+
id : deployment
66+
uses : actions/deploy-pages@v2

.gitignore

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
node_modules
2+
.idea
3+
.vscode
4+
5+
.vitepress/cache
6+
.vitepress/dist

.vitepress/config.mts

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
import { defineConfig } from 'vitepress'
2+
3+
// https://vitepress.dev/reference/site-config
4+
export default defineConfig({
5+
title: "Sub Store App",
6+
description: "Sub Store Docs",
7+
base: '/doc/',
8+
themeConfig: {
9+
// https://vitepress.dev/reference/default-theme-config
10+
nav: [
11+
{ text: 'Home', link: '/' },
12+
{ text: 'Examples', link: '/markdown-examples' }
13+
],
14+
15+
sidebar: [
16+
{
17+
text: 'Examples',
18+
items: [
19+
{ text: 'Markdown Examples', link: '/markdown-examples' },
20+
{ text: 'Runtime API Examples', link: '/api-examples' }
21+
]
22+
}
23+
],
24+
25+
socialLinks: [
26+
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' }
27+
]
28+
}
29+
})

api-examples.md

+49
Original file line numberDiff line numberDiff 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).

index.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
# https://vitepress.dev/reference/default-theme-home-page
3+
layout: home
4+
5+
hero:
6+
name: "Sub Store App"
7+
text: "Sub Store Docs"
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+

markdown-examples.md

+85
Original file line numberDiff line numberDiff 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+
````
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).

package.json

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"scripts": {
3+
"docs:dev": "vitepress dev",
4+
"docs:build": "vitepress build",
5+
"docs:preview": "vitepress preview"
6+
},
7+
"devDependencies": {
8+
"vitepress": "1.0.0-rc.10"
9+
}
10+
}

0 commit comments

Comments
 (0)