Skip to content

Commit

Permalink
feat(jzero): add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jaronnie committed Apr 11, 2024
1 parent 1b396cd commit c69693d
Show file tree
Hide file tree
Showing 16 changed files with 3,140 additions and 1 deletion.
43 changes: 43 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: deploy-docs

on:
push:
branches:
- main

permissions:
contents: write

jobs:
deploy-gh-pages:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Set node
uses: actions/setup-node@v3
with:
node-version: 20
cache: npm

- name: Install deps
run: |
corepack enable
npm ci
- name: Build Docs
env:
NODE_OPTIONS: --max_old_space_size=8192
run: |-
cd docs
npm run docs:build
> src/.vuepress/dist/.nojekyll
- name: Deploy
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages
folder: docs/src/.vuepress/dist
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ tools
.idea
filedata
dist
.sock
.sock
node_modules
5 changes: 5 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@

node_modules/
src/.vuepress/.cache/
src/.vuepress/.temp/
src/.vuepress/dist/
19 changes: 19 additions & 0 deletions docs/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"name": "jzero-docs",
"version": "1.0.0",
"description": "jzero framework",
"license": "UnLicense",
"type": "module",
"scripts": {
"docs:build": "vuepress-vite build src",
"docs:clean-dev": "vuepress-vite dev src --clean-cache",
"docs:dev": "vuepress-vite dev src",
"docs:update-package": "pnpm dlx vp-update"
},
"devDependencies": {
"@vuepress/bundler-vite": "2.0.0-rc.9",
"vue": "^3.4.21",
"vuepress": "2.0.0-rc.9",
"vuepress-theme-hope": "2.0.0-rc.35"
}
}
Loading

0 comments on commit c69693d

Please sign in to comment.