Skip to content

Commit e590e19

Browse files
committed
feat: modernize documentation site
1 parent 0922a31 commit e590e19

27 files changed

Lines changed: 3786 additions & 1773 deletions

.github/dependabot.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: npm
4+
directory: /
5+
schedule:
6+
interval: monthly
7+
open-pull-requests-limit: 5
8+
9+
- package-ecosystem: github-actions
10+
directory: /
11+
schedule:
12+
interval: monthly
13+
open-pull-requests-limit: 5
Lines changed: 18 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,31 @@
1-
# For most projects, this workflow file will not need changing; you simply need
2-
# to commit it to your repository.
3-
#
4-
# You may wish to alter this file to override the set of languages analyzed,
5-
# or to provide custom queries or build logic.
6-
#
7-
# ******** NOTE ********
8-
# We have attempted to detect the languages in your repository. Please check
9-
# the `language` matrix defined below to confirm you have the correct set of
10-
# supported CodeQL languages.
11-
#
12-
name: "CodeQL"
1+
name: CodeQL
132

143
on:
154
push:
16-
branches: [ master ]
5+
branches: [master]
176
pull_request:
18-
# The branches below must be a subset of the branches above
19-
branches: [ master ]
7+
branches: [master]
208
schedule:
21-
- cron: '43 8 * * 0'
9+
- cron: "43 8 * * 0"
10+
11+
permissions:
12+
contents: read
13+
security-events: write
2214

2315
jobs:
2416
analyze:
25-
name: Analyze
17+
name: Analyze JavaScript
2618
runs-on: ubuntu-latest
27-
permissions:
28-
actions: read
29-
contents: read
30-
security-events: write
31-
32-
strategy:
33-
fail-fast: false
34-
matrix:
35-
language: [ 'javascript' ]
36-
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
37-
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
19+
timeout-minutes: 15
3820

3921
steps:
40-
- name: Checkout repository
41-
uses: actions/checkout@v3
42-
43-
# Initializes the CodeQL tools for scanning.
44-
- name: Initialize CodeQL
45-
uses: github/codeql-action/init@v2
46-
with:
47-
languages: ${{ matrix.language }}
48-
# If you wish to specify custom queries, you can do so here or in a config file.
49-
# By default, queries listed here will override any specified in a config file.
50-
# Prefix the list here with "+" to use these queries and those in the config file.
51-
52-
# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
53-
# queries: security-extended,security-and-quality
54-
55-
56-
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
57-
# If this step fails, then you should remove it and run the build manually (see below)
58-
- name: Autobuild
59-
uses: github/codeql-action/autobuild@v2
60-
61-
# ℹ️ Command-line programs to run using the OS shell.
62-
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
63-
64-
# If the Autobuild fails above, remove it and uncomment the following three lines.
65-
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
22+
- name: Check out repository
23+
uses: actions/checkout@v6
6624

67-
# - run: |
68-
# echo "Run, Build Application using script"
69-
# ./location_of_script_within_repo/buildscript.sh
25+
- name: Initialize CodeQL
26+
uses: github/codeql-action/init@v4
27+
with:
28+
languages: javascript-typescript
7029

71-
- name: Perform CodeQL Analysis
72-
uses: github/codeql-action/analyze@v2
30+
- name: Perform CodeQL analysis
31+
uses: github/codeql-action/analyze@v4

.github/workflows/pages.yml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Deploy documentation
2+
3+
on:
4+
push:
5+
branches: [master]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: pages
15+
cancel-in-progress: true
16+
17+
jobs:
18+
deploy:
19+
name: Build and deploy
20+
runs-on: ubuntu-latest
21+
timeout-minutes: 15
22+
environment:
23+
name: github-pages
24+
url: ${{ steps.deployment.outputs.page_url }}
25+
26+
steps:
27+
- name: Check out repository
28+
uses: actions/checkout@v6
29+
30+
- name: Set up Node.js
31+
uses: actions/setup-node@v6
32+
with:
33+
node-version: 24
34+
cache: yarn
35+
36+
- name: Install dependencies
37+
run: corepack yarn install --frozen-lockfile
38+
39+
- name: Build site
40+
run: corepack yarn build
41+
42+
- name: Configure Pages
43+
uses: actions/configure-pages@v5
44+
45+
- name: Upload Pages artifact
46+
uses: actions/upload-pages-artifact@v4
47+
with:
48+
path: dist
49+
50+
- name: Deploy to GitHub Pages
51+
id: deployment
52+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
node_modules/
2+
dist/
3+
*.log

.prettierignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
docs/resources/*
1+
docs/vendor/
2+
docs/res/
3+
yarn.lock

0 commit comments

Comments
 (0)