Skip to content

Commit 2b49f8f

Browse files
committed
Replace docsify with Starlight for docs site
Docsify has an unfixable vulnerability in its marked dependency. Starlight (Astro) provides a modern, maintained alternative. - Scaffold Starlight project in docs/ with isolated dependencies - Sync script derives docs content from root README.md - Add GitHub Actions workflow for Pages deployment - Bump CI actions from v3 to v4
1 parent b5369aa commit 2b49f8f

File tree

18 files changed

+6875
-879
lines changed

18 files changed

+6875
-879
lines changed

.github/workflows/ci.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ jobs:
1919
COVERAGE: ${{ matrix.node-version == '20.x' && true || false }}
2020

2121
steps:
22-
- uses: actions/checkout@v3
22+
- uses: actions/checkout@v4
2323
- name: Use Node.js ${{ matrix.node-version }}
24-
uses: actions/setup-node@v3
24+
uses: actions/setup-node@v4
2525
with:
2626
node-version: ${{ matrix.node-version }}
2727
- run: npm ci
@@ -34,13 +34,13 @@ jobs:
3434
- name: Run browser tests
3535
run: npm run test:browser
3636
- name: Report coverage
37-
uses: codecov/codecov-action@v3
37+
uses: codecov/codecov-action@v4
3838

3939
test-bun:
4040
runs-on: ubuntu-latest
4141
steps:
42-
- uses: actions/checkout@v3
43-
- uses: actions/setup-node@v3
42+
- uses: actions/checkout@v4
43+
- uses: actions/setup-node@v4
4444
with:
4545
node-version: 20.x
4646
- uses: oven-sh/setup-bun@v2
@@ -53,8 +53,8 @@ jobs:
5353
test-deno:
5454
runs-on: ubuntu-latest
5555
steps:
56-
- uses: actions/checkout@v3
57-
- uses: actions/setup-node@v3
56+
- uses: actions/checkout@v4
57+
- uses: actions/setup-node@v4
5858
with:
5959
node-version: 20.x
6060
- uses: denoland/setup-deno@v2

.github/workflows/docs.yml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Deploy Docs
2+
3+
on:
4+
push:
5+
branches: [master]
6+
paths:
7+
- "docs/**"
8+
- "README.md"
9+
workflow_dispatch:
10+
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
concurrency:
17+
group: pages
18+
cancel-in-progress: true
19+
20+
jobs:
21+
build:
22+
runs-on: ubuntu-latest
23+
steps:
24+
- uses: actions/checkout@v4
25+
- uses: actions/setup-node@v4
26+
with:
27+
node-version: 20
28+
- name: Install docs dependencies
29+
run: npm ci
30+
working-directory: docs
31+
- name: Build docs
32+
run: npm run build
33+
working-directory: docs
34+
- uses: actions/upload-pages-artifact@v3
35+
with:
36+
path: docs/dist
37+
38+
deploy:
39+
needs: build
40+
runs-on: ubuntu-latest
41+
environment:
42+
name: github-pages
43+
url: ${{ steps.deployment.outputs.page_url }}
44+
steps:
45+
- id: deployment
46+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,3 +94,7 @@ bower_components
9494
AGENTS.md
9595
CLAUDE.md
9696
.claude/
97+
98+
# Astro (docs)
99+
docs/.astro/
100+
docs/src/content/docs/

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 📝 tslog: Beautiful logging experience for TypeScript and JavaScript
1+
# Beautiful logging experience for TypeScript
22

33
[![lang: Typescript](https://img.shields.io/badge/Language-Typescript-Blue.svg?style=flat-square)](https://www.typescriptlang.org)
44
![License: MIT](https://img.shields.io/npm/l/tslog?logo=tslog&style=flat-square)

docs/.nojekyll

Whitespace-only changes.

0 commit comments

Comments
 (0)