prepare to deploy docs to pages
This commit is contained in:
parent
dac64617cc
commit
4c9bd6bd3e
3 changed files with 73 additions and 9 deletions
62
.github/workflows/docs.yml
vendored
Normal file
62
.github/workflows/docs.yml
vendored
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
# build the docs and deploy to github-pages
|
||||
name: Build Docs and Deploy to Pages
|
||||
|
||||
on: workflow_dispatch
|
||||
# later: auto-build on version tags
|
||||
|
||||
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
|
||||
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
|
||||
with:
|
||||
fetch-depth: 0 # required for VitePress lastUpdated support
|
||||
ref: docs
|
||||
|
||||
- name: Setup Node
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 22
|
||||
cache: npm
|
||||
|
||||
- name: Setup Pages
|
||||
uses: actions/configure-pages@v4
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Export Block Definitions to Markdown
|
||||
run: npm run docs:export
|
||||
|
||||
- name: Build with VitePress
|
||||
run: npm run docs:build
|
||||
|
||||
- name: Upload artifact
|
||||
uses: actions/upload-pages-artifact@v3
|
||||
with:
|
||||
path: docs/.vitepress/dist
|
||||
|
||||
deploy:
|
||||
environment:
|
||||
name: github-pages
|
||||
url: ${{ steps.deployment.outputs.page_url }}
|
||||
needs: build
|
||||
runs-on: ubuntu-latest
|
||||
name: Deploy
|
||||
steps:
|
||||
- name: Deploy to GitHub Pages
|
||||
id: deployment
|
||||
uses: actions/deploy-pages@v4
|
||||
|
|
@ -20,18 +20,18 @@ export default {
|
|||
"-",
|
||||
"Template Variables:",
|
||||
"---------------",
|
||||
"{{ variables.var_name }} - get the value of a variable you have defined",
|
||||
"/{/{ variables.var_name }} - get the value of a variable you have defined",
|
||||
" with name 'var_name'",
|
||||
"{{ vars.var_name }} - shorthand for same as above",
|
||||
"{{ variables['var name'] }} - get the value of a variable you have",
|
||||
"/{/{ vars.var_name }} - shorthand for same as above",
|
||||
"/{/{ variables['var name'] }} - get the value of a variable you have",
|
||||
" defined with name 'var name' (allows spaces in variable names",
|
||||
"{{ vars['var name'] }} - shorthand for same as above",
|
||||
"{{ user.name }} - your user's name",
|
||||
"{{ user.username }} - your user's username",
|
||||
"{{ feeds['group_key.feed_key'].name }} - access a feed with key",
|
||||
"/{/{ vars['var name'] }} - shorthand for same as above",
|
||||
"/{/{ user.name }} - your user's name",
|
||||
"/{/{ user.username }} - your user's username",
|
||||
"/{/{ feeds['group_key.feed_key'].name }} - access a feed with key",
|
||||
" 'group_key.feed_key' and get its name",
|
||||
"{{ feeds[...].key }} - ...get its key",
|
||||
"{{ feeds[...].value }} - ...get its last value",
|
||||
"/{/{ feeds[...].key }} - ...get its key",
|
||||
"/{/{ feeds[...].value }} - ...get its last value",
|
||||
].join('\n'),
|
||||
},
|
||||
|
||||
|
|
|
|||
|
|
@ -13,6 +13,8 @@ export default defineConfig({
|
|||
['link', { rel: 'icon', href: "data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>🧩</text></svg>" }]
|
||||
],
|
||||
|
||||
base: "/blockly-tool/",
|
||||
|
||||
// https://vitepress.dev/reference/default-theme-config
|
||||
themeConfig: {
|
||||
search: {
|
||||
|
|
|
|||
Loading…
Reference in a new issue