Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .execs/docs.flow
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,31 @@
visibility: public
tags: [docs]
executables:
- verb: start
name: site
aliases: [docs]
description: Run the documentation site locally (from prerendered content)
serial:
dir: //
execs:
- ref: build docs
- cmd: npx serve dist -l 3000

- verb: start
name: docsify
description: Run the documentation site locally using the docsify CLI
exec:
dir: //
cmd: docsify serve docs --open

- verb: build
name: docs
description: Prerender docsify documentation site for the project
exec:
dir: //
cmd:
node ./scripts/prerender.js

- verb: show
name: flowfile
aliases: [executables, exec, executable]
Expand Down
8 changes: 0 additions & 8 deletions .execs/setup.flow
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,6 @@ executables:
dir: //
cmd: go install ./...

- verb: start
name: site
aliases: [docs]
description: Run the documentation site locally
exec:
dir: //
cmd: docsify serve docs --open

- verb: start
name: recording
aliases: [vhs]
Expand Down
9 changes: 8 additions & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,19 @@ jobs:
- name: Generate docs
run: |
go run ./tools/docsgen/.
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: '24'
- run: npm install docsify-server-renderer@^4
- name: Prerender Docsify
run: node tools/prerender.js
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v4
with:
path: 'docs/'
path: 'dist/'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@main
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
*.dylib
.DS_Store

node_modules/

# Test binary, built with `go test -c`
*.test

Expand Down
184 changes: 184 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"dependencies": {
"docsify-server-renderer": "^4.13.1"
}
}
Loading