Skip to content

Commit c503885

Browse files
authored
docs: fix build (piscinajs#729)
1 parent b446da7 commit c503885

File tree

4 files changed

+38
-1
lines changed

4 files changed

+38
-1
lines changed

.github/workflows/docs-test.yml

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: 'Documentation Build Test'
2+
on:
3+
pull_request:
4+
paths:
5+
- docs/**
6+
7+
jobs:
8+
build:
9+
permissions:
10+
contents: read
11+
name: Build
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v4
15+
with:
16+
persist-credentials: false
17+
18+
- name: Use Node.js LTS
19+
uses: actions/setup-node@v4
20+
with:
21+
node-version: 'lts/*'
22+
cache: 'yarn'
23+
cache-dependency-path: docs/package.json
24+
25+
- name: Install Dependencies
26+
run: |
27+
cd docs
28+
yarn install --frozen-lockfile
29+
30+
- name: build
31+
run: |
32+
cd docs
33+
yarn build

.github/workflows/nodejs.yml

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ on:
55
- next
66
- 'v*'
77
pull_request:
8+
paths-ignore:
9+
- docs/**
810

911
name: CI
1012

.npmignore

+2
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,5 @@
33
package-lock.json
44
coverage
55
examples
6+
docs/**/*
7+
!docs/docs/**/*.md

docs/docs/getting-started/basic-usage.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ const piscina = new Piscina({
4646

4747
## Using a Worker Wrapper File in a TypeScript Project
4848

49-
When working with TypeScript, you need to use a `workerWrapper.js` file to load your worker file correctly. This file checks if the provided file path ends with `.ts` and registers the `ts-node` compiler to handle TypeScript files. You can learn more about using Typescript with Piscina in the [examples section](../examples/typescript.mdx).
49+
When working with TypeScript, you need to use a `workerWrapper.js` file to load your worker file correctly. This file checks if the provided file path ends with `.ts` and registers the `ts-node` compiler to handle TypeScript files. You can learn more about using Typescript with Piscina in the following [guide](./typescript.mdx).
5050

5151
<WorkerWrapperComponent/>
5252

0 commit comments

Comments
 (0)