Add auto building for page

This commit is contained in:
Jesse Wierzbinski 2023-11-25 15:31:54 -10:00
parent 636b9174f4
commit bf61dc7cea
No known key found for this signature in database
7 changed files with 81 additions and 2 deletions

61
.github/workflows/deploy.yml vendored Normal file
View file

@ -0,0 +1,61 @@
# Sample workflow for building and deploying a VitePress site to GitHub Pages
#
name: Deploy VitePress site to Pages
on:
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
# using the `master` branch as the default branch.
push:
branches: [main]
# 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 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 job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0 # Not needed if lastUpdated is not enabled
# - uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm
- uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Install dependencies
run: bun install
- name: Build with VitePress
run: |
bun run docs:build
touch docs/.vitepress/dist/.nojekyll
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: docs/.vitepress/dist
# Deployment job
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@v2

3
.gitignore vendored
View file

@ -1,2 +1,3 @@
node_modules
.vitepress/cache
.vitepress/cache
.vitepress/dist

17
Dockerfile Normal file
View file

@ -0,0 +1,17 @@
FROM oven/bun:alpine
COPY . /app
RUN cd ./app && bun install
RUN cd ./app && bun docs:build
FROM oven/bun:alpine
COPY --from=builder /app/.vitepress/dist/ /app
LABEL org.opencontainers.image.authors "Gaspard Wierzbinski (https://cpluspatch.com)"
LABEL org.opencontainers.image.source "https://github.com/lysand-org/docs"
LABEL org.opencontainers.image.vendor "Lysand.org"
LABEL org.opencontainers.image.licenses "MIT"
LABEL org.opencontainers.image.title "Lysand Docs"
LABEL org.opencontainers.image.description "Documentation for Lysand"

View file

0
docs/objects/actions.md Normal file
View file

0
docs/objects/actors.md Normal file
View file

View file

@ -151,7 +151,7 @@ It is recommended that servers limit the length of the subject from 1 to 300 cha
The `subject` field **MUST NOT** be a `ContentFormat` object. It **MUST** be a string, and **MUST** be plain text. It **MUST NOT** contain any HTML or other markup.
> See [ContentFormat](#contentformat) for more information on `ContentFormat` objects.
> See [ContentFormat](/structures/content-format) for more information on `ContentFormat` objects.
> Client extensions are welcome to add support for HTML or other markup in the `subject` field, but it is not recommended.