Skip to content
Open
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
10 changes: 10 additions & 0 deletions .github/workflows/static.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,16 @@ jobs:
uses: actions/setup-go@v5
with:
go-version-file: ./go.mod
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 22
- name: Enable pnpm
run: corepack enable
- name: Install documentation dependencies
run: pnpm install --frozen-lockfile
- name: Build API documentation
run: pnpm docs:build
- name: Generate coverage and badge
run: |
make test
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
PLAN.md
node_modules/
/ci/out/
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
[![Go Reference](https://pkg.go.dev/badge/github.com/coder/websocket.svg)](https://pkg.go.dev/github.com/coder/websocket)
[![Go Coverage](https://coder.github.io/websocket/coverage.svg)](https://coder.github.io/websocket/coverage.html)

[API documentation](https://coder.github.io/websocket/) includes searchable
reference pages for the core package and the `wsjson` helpers.

websocket is a minimal and idiomatic WebSocket library for Go.

## Install
Expand Down
11 changes: 11 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"name": "coder-websocket-docs",
"private": true,
"packageManager": "pnpm@11.7.0",
"scripts": {
"docs:build": "sourcey build -o ci/out/static && node scripts/normalize-doc-links.mjs"
},
"devDependencies": {
"sourcey": "3.6.5"
}
}
Loading
Loading