docs(website): replace old website by vitepress by daker · Pull Request #3315 · Kitware/vtk-js

daker · 2025-08-14T23:41:33Z

Context

Results

Changes

Documentation and TypeScript definitions were updated to match those changes

PR and Code Checklist

semantic-release commit messages
Run npm run reformat to have correctly formatted code

Testing

This change adds or fixes unit tests
Tested environment:
- vtk.js:
- OS:
- Browser:

daker · 2025-08-14T23:41:49Z

@floryst

daker · 2026-02-01T21:18:30Z

@finetjul Could you review this PR? I've added the example build, we can merge it and continue updating it.

jourdain · 2026-02-02T15:19:38Z

Thanks @daker, this is amazing! But can you rename your commit to docs(website): replace old website by vitepress so we don't trigger a release for no change in the library.

daker · 2026-02-02T15:23:06Z

@jourdain it's done

jourdain · 2026-02-02T15:27:13Z

+# WebGPU Examples

 WebGPU is the upcoming high performance rendering API coming soon to browsers across all major platforms. vtk.js has preliminary support for WebGPU and you can explore some of its features in the examples below. Note that both WebGPU and our support for it are still under development so these examples may break as the API changes. Most of these examples have been tested with Chrome Canary on Windows and MacOS.
-


Are the WebGPU examples removed in the gallery?

i don't recall we had WebGPU examples in the gallery https://kitware.github.io/vtk-js/examples/#Applications

From the diff, it seems that the listing of the examples were removed in that md file.

https://kitware.github.io/vtk-js/docs/develop_webgpu.html

Although those links should have the extra arg to activate webgpu... Weirdly enough, those links don't seems to work either.

Ah, I see. In theory, they should appear in the gallery

jourdain · 2026-02-02T15:49:17Z

+        run: npm run doc:generate-gallery
      - name: Build docs
-        run: npm run doc:minified
+        run: npm run doc:build


typo: => docs:build ?

Also that step trigger the following error

[vite:vue] [plugin vite:vue] Documentation/content/api/Filters_General_ContourTriangulator.md (163:13): Element is missing end tag. file: /Users/sebastien.jourdain/Desktop/vtk-js/Documentation/content/api/Filters_General_ContourTriangulator.md:163:13

And much more after too

yes i will fix it

Also that step trigger the following error

[vite:vue] [plugin vite:vue] Documentation/content/api/Filters_General_ContourTriangulator.md (163:13): Element is missing end tag. file: /Users/sebastien.jourdain/Desktop/vtk-js/Documentation/content/api/Filters_General_ContourTriangulator.md:163:13

i am not sure this, i will retest again on my machine

jourdain · 2026-02-02T15:55:21Z

The build steps don't complete without errors.

npm run build:release
npm run build:examples
npm run doc:generate-api
npm run doc:generate-examples
npm run doc:generate-sidebar
npm run doc:generate-gallery
npm run doc:build # <-- typo + when running (docs:build) it fails
npm run doc:build-examples

jourdain

Really amazing work, but we need to make sure the CI will complete (no error) and that API is not failing with "element missing endtag"

daker · 2026-02-02T16:51:51Z

@jourdain i think it should work now, here are the steps:

npm run build:release
npm run docs:generate-api # <-- i have added an "s" doc to follow vitepress naming
npm run docs:generate-examples
npm run docs:generate-sidebar
npm run docs:generate-gallery
npm run docs:build
npm run docs:build-examples <- examples for the websites are build with rollup now, much faster compared to webpack

daker · 2026-02-02T17:01:00Z

The PR check failures are due to the command being renamed from doc to docs.

jourdain · 2026-02-02T17:16:44Z

Looks good to me, but we need to ensure that we have time to monitor and fix any major issue once we merge it.

jourdain · 2026-02-02T17:17:51Z

@finetjul can you handle it sometime this week?

daker · 2026-02-02T17:19:09Z

@jourdain yes that's the goal, we can merge then i will to fix any remaning issue, the OfflineLocalView example is present in the list

jourdain · 2026-02-02T17:23:04Z

Here you go @daker ! Hopefully it will be a somewhat smooth transition ;-)

jourdain · 2026-02-02T17:28:30Z

I guess you have a PR coming soon to fix the doc/docs call issue on the ci.

jourdain · 2026-02-02T17:29:22Z

Please tag me so I can review/merge them as fast as I see them ;-)

jourdain · 2026-02-02T17:37:56Z

Wow, it is up and live...

jourdain · 2026-02-02T17:39:42Z

I see some issue with the logo and the examples images but the rest seems in pretty good shape! Well done!

daker · 2026-02-02T17:41:59Z

@jourdain yes not bad, i will fix the remaning issues in few hours

jourdain · 2026-02-02T17:44:38Z

It seems that the examples are not available either when you click on them.

jourdain · 2026-02-02T18:38:58Z

I pushed a fix when I always use a base of /vtk-js. The build is currently running.

=> still does not fix images and examples. I think more work needs to be done to properly use the /vtk-js base.

jourdain · 2026-02-02T18:41:19Z

Do we need both build:examples and docs:build-examples?

daker · 2026-02-02T19:10:34Z

No only docs:build-examples, you can omit the first one

jourdain · 2026-02-02T19:12:51Z

Please update the ci file to skip it.

daker · 2026-02-02T19:14:39Z

Yes i will fix the remaining issues tonight

finetjul · 2026-02-16T13:35:47Z

@daker I tried to build the website locally with no luck.

I have the following warning:

The language './webpack.config.js' is not loaded, falling back to 'txt' for syntax highlighting.

And it seems to fail with text such as {% endnote %} in develop_requirement.md (Markdown is not applied ?)

daker · 2026-02-16T13:40:51Z

@finetjul are you sure your local workspace is clean ? i have fixed all those isssues and we don't have {% endnote %} in develop_requirement.md anymore https://raw.githubusercontent.com/Kitware/vtk-js/948a8979005128997919ddb480979f14b55c7fe5/Documentation/docs/develop_requirement.md

finetjul · 2026-02-16T13:52:07Z

Indeed, my bad, my master was outdated. 😅

After updating it, I have the following error:

Could not resolve "../../../examples/gallery.js" from "Documentation/.vitepress/theme/components/ExamplesGallery.vue"
file: C:/Work/vtk.js/vtk-js/Documentation/.vitepress/theme/components/ExamplesGallery.vue

I fix it by calling npm run docs:generate-gallery before npm run docs:build.
Maybe it should be documented somewhere.

daker force-pushed the switch-vitepress branch 2 times, most recently from c87f049 to 849aa50 Compare February 1, 2026 01:09

daker marked this pull request as ready for review February 1, 2026 01:09

daker force-pushed the switch-vitepress branch 3 times, most recently from 2100255 to 0dfd2ea Compare February 1, 2026 21:15

daker force-pushed the switch-vitepress branch from 0dfd2ea to dbe7e10 Compare February 2, 2026 15:22

daker changed the title ~~feat(Documentation): migrate to vitepress~~ docs(website): replace old website by vitepress Feb 2, 2026

jourdain reviewed Feb 2, 2026

View reviewed changes

jourdain self-requested a review February 2, 2026 15:55

jourdain requested changes Feb 2, 2026

View reviewed changes

docs(website): replace old website by vitepress

c02ff66

daker force-pushed the switch-vitepress branch from dbe7e10 to c02ff66 Compare February 2, 2026 16:49

jourdain self-requested a review February 2, 2026 17:16

jourdain approved these changes Feb 2, 2026

View reviewed changes

jourdain merged commit fe574fa into Kitware:master Feb 2, 2026
1 of 2 checks passed

daker deleted the switch-vitepress branch February 2, 2026 17:31

		# WebGPU Examples

		WebGPU is the upcoming high performance rendering API coming soon to browsers across all major platforms. vtk.js has preliminary support for WebGPU and you can explore some of its features in the examples below. Note that both WebGPU and our support for it are still under development so these examples may break as the API changes. Most of these examples have been tested with Chrome Canary on Windows and MacOS.

Uh oh!

Conversation

daker commented Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Context

Results

Changes

PR and Code Checklist

Testing

Uh oh!

daker commented Aug 14, 2025

Uh oh!

daker commented Feb 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jourdain commented Feb 2, 2026

Uh oh!

daker commented Feb 2, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jourdain commented Feb 2, 2026

Uh oh!

jourdain left a comment

Choose a reason for hiding this comment

Uh oh!

daker commented Feb 2, 2026

Uh oh!

daker commented Feb 2, 2026

Uh oh!

jourdain commented Feb 2, 2026

Uh oh!

jourdain commented Feb 2, 2026

Uh oh!

daker commented Feb 2, 2026

Uh oh!

Uh oh!

jourdain commented Feb 2, 2026

Uh oh!

jourdain commented Feb 2, 2026

Uh oh!

jourdain commented Feb 2, 2026

Uh oh!

jourdain commented Feb 2, 2026

Uh oh!

jourdain commented Feb 2, 2026

Uh oh!

daker commented Feb 2, 2026

Uh oh!

jourdain commented Feb 2, 2026

Uh oh!

jourdain commented Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jourdain commented Feb 2, 2026

Uh oh!

daker commented Feb 2, 2026

Uh oh!

daker commented Aug 14, 2025 •

edited

Loading

daker commented Feb 1, 2026 •

edited

Loading

jourdain commented Feb 2, 2026 •

edited

Loading

finetjul commented Feb 16, 2026 •

edited

Loading