Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
b7269dd
chore(docs): add guides and codelabs
maribethb Jan 15, 2026
2aa1aa8
chore(docs): add docs static resources
maribethb Jan 15, 2026
f4c6a27
chore(docs): add google analytics tracking code
maribethb Jan 15, 2026
27b4d86
chore(docs): move docs to packages dir
maribethb Jan 20, 2026
5b22be3
chore(docs): add docs workspace basic files
maribethb Jan 21, 2026
2b0e4c8
chore(docs): GitHub Actions Workflow for deploying docs to Pages
grega Mar 17, 2026
f5d792b
chore(docs): update docs config and paths (removing `blockly/`)
grega Mar 17, 2026
89d608d
chore(docs): add Docusaurus components
grega Mar 31, 2026
28fe803
chore(docs): add custom styles
grega Mar 31, 2026
4b921fb
chore(docs): add Docusaurus supporting elements
grega Mar 31, 2026
beb7a14
chore(docs): add Gulp tasks
grega Mar 31, 2026
15307fd
chore(docs): remove unneeded toc.yaml
grega Mar 31, 2026
bba5468
chore(docs): remove unused CSS
grega Mar 31, 2026
f6a9020
chore(docs): fix incorrect image paths in Markdown and Image component
grega Mar 31, 2026
ef3cea8
chore(docs): allow all search engine indexing
grega Mar 31, 2026
3504048
chore(docs): update theme colours, remove unneeded style declarations
grega Mar 31, 2026
9273512
chore(docs): remove unused custom styles
grega Mar 31, 2026
50591e0
chore(docs): tidy Docusaurus config
grega Mar 31, 2026
eb6f6c3
chore(docs): change path from /js/reference/ to /reference/
grega Mar 31, 2026
8b2ea01
chore(docs): clarify deployment / workflow comment
grega Mar 31, 2026
8ae5974
chore(docs): remove ClassBlack component, add individual components i…
grega Mar 31, 2026
8839c16
chore(docs): move all Docusuarus-related images into single dir
grega Mar 31, 2026
ec19340
chore(docs): remove TableHeader component, simplify tables in Markdown
grega Mar 31, 2026
f5dcfb9
chore(docs): CSS syntax fixes
grega Mar 31, 2026
231a9b1
chore(docs): add Prettier config (and ignore) for docs
grega Mar 31, 2026
45168a6
chore(docs): run `prettier --write` on docs
grega Mar 31, 2026
8982178
chore(docs): switch to eslint for mdx linting/formatting
grega Mar 31, 2026
e864021
chore(docs): run eslint on docs
grega Mar 31, 2026
87718a5
chore(docs): update README docs on formatting and linting
grega Mar 31, 2026
6692142
chore(docs): point docs Workflow at root-level package.json
grega Apr 3, 2026
7d3fc22
chore(docs): fix Actions workflow to correctly build reference docs
grega Apr 3, 2026
1982061
chore(docs): generate just typings for docs build Workflow
grega Apr 3, 2026
b51bb27
chore(docs): set Docusaurus base_url in env var
grega Apr 3, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
79 changes: 79 additions & 0 deletions .github/workflows/deploy-docusaurus.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# .github/workflows/deploy-docusaurus.yml
# This workflow deploys the Blockly documentation to GitHub Pages.
# Run this manually after a release to publish updated documentation.

name: Deploy Docusaurus to GitHub Pages

on:
# To run: GitHub -> Actions -> "Deploy Docusaurus to GitHub Pages" -> Run workflow
# Optionally set `ref` to the release branch/tag
workflow_dispatch:
inputs:
ref:
description: 'Branch, tag, or commit SHA to deploy (defaults to main)'
required: false
default: 'main'
type: string

# Sets the permissions for 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:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout your repository
uses: actions/checkout@v4
with:
ref: ${{ inputs.ref || 'main' }}
# Allow Docusaurus to view the full commit history (required for "last edited at <date> by <person>" functionality)
fetch-depth: 0

- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: 20.x
cache: 'npm'
cache-dependency-path: 'package-lock.json' # root level, since we're using npm workspaces

- name: Install dependencies
run: npm ci

- name: Generate reference docs
working-directory: ./packages/blockly
run: |
npx gulp typings
npm run docs

- name: Build the Docusaurus site
working-directory: ./packages/docs
run: npm run build
env:
# when deploying to a subdirectory of the <org>.github.io domain,
# we need to set the BASE_URL to the name of the repo, for a custom
# domain this could be /docs/
BASE_URL: /blockly/

- name: Setup GitHub Pages
uses: actions/configure-pages@v5

- name: Upload build artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./packages/docs/build

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
Loading