docs: add api reference by gka · Pull Request #322 · svelteplot/svelteplot

gka · 2026-01-04T22:53:45Z

This pull request introduces improvements to the documentation and minor UI tweaks. The main focus is on expanding the sidebar navigation to include an API Reference section and adding a script for generating API documentation for marks. Additionally, there is a small change to the Link.svelte component for cleaner rendering of child elements.

Documentation improvements:

Added an "API Reference" section to the sidebar navigation in config/sidebar.ts, with a link to the marks API page.
Added a new npm script docs:api:marks in package.json to generate API documentation for marks using generate-mark-api.js.

UI component update:

Updated the rendering logic in src/theme/components/Link.svelte for more concise child element rendering.

netlify · 2026-01-04T22:53:50Z

✅ Deploy Preview for svelteplot ready!

Name	Link
🔨 Latest commit	`00d487e`
🔍 Latest deploy log	https://app.netlify.com/projects/svelteplot/deploys/695b06f86eee900008904124
😎 Deploy Preview	https://deploy-preview-322--svelteplot.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

github-actions · 2026-01-04T22:55:19Z

📦 Preview package for this PR is published!

Version: 0.9.1-pr-322.0

Install it with:

npm install svelteplot@pr-322
# or install the specific version
npm install [email protected]

github-actions · 2026-01-04T22:55:52Z

TypeScript error report:

This branch: 975
main branch: 904
Difference (PR - main): +71 ⚠️

github-actions · 2026-01-04T22:56:34Z

📦 Preview package for this PR is published!

Version: 0.9.1-pr-322.1

Install it with:

npm install svelteplot@pr-322
# or install the specific version
npm install [email protected]

github-actions · 2026-01-04T22:57:50Z

TypeScript error report:

This branch: 975
main branch: 904
Difference (PR - main): +71 ⚠️

github-actions · 2026-01-04T22:58:30Z

📦 Preview package for this PR is published!

Version: 0.9.1-pr-322.2

Install it with:

npm install svelteplot@pr-322
# or install the specific version
npm install [email protected]

github-actions · 2026-01-04T23:08:09Z

TypeScript error report:

This branch: 859
main branch: 859
Difference (PR - main): 0 ℹ️

github-actions · 2026-01-04T23:08:49Z

📦 Preview package for this PR is published!

Version: 0.9.1-pr-322.3

Install it with:

npm install svelteplot@pr-322
# or install the specific version
npm install [email protected]

github-actions · 2026-01-04T23:19:26Z

TypeScript error report:

This branch: 859
main branch: 859
Difference (PR - main): 0 ℹ️

github-actions · 2026-01-04T23:20:14Z

📦 Preview package for this PR is published!

Version: 0.9.1-pr-322.4

Install it with:

npm install svelteplot@pr-322
# or install the specific version
npm install [email protected]

github-actions · 2026-01-04T23:46:47Z

📦 Preview package for this PR is published!

Version: 0.9.1-pr-322.5

Install it with:

npm install svelteplot@pr-322
# or install the specific version
npm install [email protected]

github-actions · 2026-01-05T00:06:55Z

📦 Preview package for this PR is published!

Version: 0.9.1-pr-322.6

Install it with:

npm install svelteplot@pr-322
# or install the specific version
npm install [email protected]

github-actions · 2026-01-05T00:26:06Z

📦 Preview package for this PR is published!

Version: 0.9.1-pr-322.7

Install it with:

npm install svelteplot@pr-322
# or install the specific version
npm install [email protected]

github-actions · 2026-01-05T00:26:24Z

TypeScript error report:

This branch: 859
main branch: 859
Difference (PR - main): 0 ℹ️

github-actions · 2026-01-05T00:26:55Z

📦 Preview package for this PR is published!

Version: 0.9.1-pr-322.8

Install it with:

npm install svelteplot@pr-322
# or install the specific version
npm install [email protected]

github-actions · 2026-01-05T00:32:30Z

TypeScript error report:

This branch: 859
main branch: 859
Difference (PR - main): 0 ℹ️

github-actions · 2026-01-05T00:32:58Z

TypeScript error report:

This branch: 859
main branch: 859
Difference (PR - main): 0 ℹ️

github-actions · 2026-01-05T00:33:14Z

📦 Preview package for this PR is published!

Version: 0.9.1-pr-322.9

Install it with:

npm install svelteplot@pr-322
# or install the specific version
npm install [email protected]

github-actions · 2026-01-05T00:33:42Z

📦 Preview package for this PR is published!

Version: 0.9.1-pr-322.10

Install it with:

npm install svelteplot@pr-322
# or install the specific version
npm install [email protected]

github-actions · 2026-01-05T00:34:46Z

TypeScript error report:

This branch: 859
main branch: 859
Difference (PR - main): 0 ℹ️

github-actions · 2026-01-05T00:35:32Z

📦 Preview package for this PR is published!

Version: 0.9.1-pr-322.11

Install it with:

npm install svelteplot@pr-322
# or install the specific version
npm install [email protected]

yutannihilation · 2026-01-05T01:37:09Z

Thanks for adding the references! This is great.

I noticed a minor problem. It seems { and } get unexpectedly escaped.

https://svelteplot.dev/api/plot

docs: add api reference

1197c63

gka temporarily deployed to npm January 4, 2026 22:54 — with GitHub Actions Inactive

code formatting

65043b4

gka temporarily deployed to npm January 4, 2026 22:55 — with GitHub Actions Inactive

Merge branch 'main' into docs/api-reference

ce3be87

gka temporarily deployed to npm January 4, 2026 22:57 — with GitHub Actions Inactive

ignore TS errors in scripts

379f896

gka temporarily deployed to npm January 4, 2026 23:08 — with GitHub Actions Inactive

docs: link to api reference from all marks

c09cbbb

gka temporarily deployed to npm January 4, 2026 23:19 — with GitHub Actions Inactive

gka added 3 commits January 5, 2026 00:30

add plot and transforms api reference links

629eae2

docs: add plot and transforms api reference

415d87e

improve transform api refs

1400f31

gka temporarily deployed to npm January 4, 2026 23:46 — with GitHub Actions Inactive

gka added 4 commits January 5, 2026 01:03

improve transform api reference

1e842c2

remove unused plot argument from interval transform

215ec3d

docs

85a9f7e

..

50d044b

gka temporarily deployed to npm January 5, 2026 00:06 — with GitHub Actions Inactive

gka added 2 commits January 5, 2026 01:24

link to transform reference

49a7eea

format after api docs gen

7acc7ad

gka temporarily deployed to npm January 5, 2026 00:26 — with GitHub Actions Inactive

gka added 2 commits January 5, 2026 01:31

collapse sidebar groups by default

b2ca271

..

2b88ed2

gka temporarily deployed to npm January 5, 2026 00:33 — with GitHub Actions Inactive

...

00d487e

gka temporarily deployed to npm January 5, 2026 00:34 — with GitHub Actions Inactive

gka merged commit 233a47e into main Jan 5, 2026
4 checks passed

gka deleted the docs/api-reference branch January 5, 2026 00:35

Uh oh!

Conversation

gka commented Jan 4, 2026

Uh oh!

netlify Bot commented Jan 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for svelteplot ready!

Uh oh!

github-actions Bot commented Jan 4, 2026

Uh oh!

github-actions Bot commented Jan 4, 2026

Uh oh!

github-actions Bot commented Jan 4, 2026

Uh oh!

github-actions Bot commented Jan 4, 2026

Uh oh!

github-actions Bot commented Jan 4, 2026

Uh oh!

github-actions Bot commented Jan 4, 2026

Uh oh!

github-actions Bot commented Jan 4, 2026

Uh oh!

github-actions Bot commented Jan 4, 2026

Uh oh!

github-actions Bot commented Jan 4, 2026

Uh oh!

github-actions Bot commented Jan 4, 2026

Uh oh!

github-actions Bot commented Jan 5, 2026

Uh oh!

github-actions Bot commented Jan 5, 2026

Uh oh!

github-actions Bot commented Jan 5, 2026

Uh oh!

github-actions Bot commented Jan 5, 2026

Uh oh!

github-actions Bot commented Jan 5, 2026

Uh oh!

github-actions Bot commented Jan 5, 2026

Uh oh!

github-actions Bot commented Jan 5, 2026

Uh oh!

github-actions Bot commented Jan 5, 2026

Uh oh!

github-actions Bot commented Jan 5, 2026

Uh oh!

Uh oh!

github-actions Bot commented Jan 5, 2026

Uh oh!

yutannihilation commented Jan 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

netlify Bot commented Jan 4, 2026 •

edited

Loading