Skip to content

Commit 3766f16

Browse files
jourdainjourdain
committed
initial website
1 parent aaa7225 commit 3766f16

File tree

20 files changed

+2728
-19
lines changed

20 files changed

+2728
-19
lines changed

‎.github/workflows/website.yaml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Sample workflow for building and deploying a VitePress site to GitHub Pages
2+
#
3+
name: Deploy VitePress site to Pages
4+
5+
on:
6+
push:
7+
branches: [main]
8+
9+
# Allows you to run this workflow manually from the Actions tab
10+
workflow_dispatch:
11+
12+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
19+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
20+
concurrency:
21+
group: pages
22+
cancel-in-progress: false
23+
24+
jobs:
25+
# Build job
26+
build:
27+
runs-on: ubuntu-latest
28+
steps:
29+
- name: Checkout
30+
uses: actions/checkout@v4
31+
- name: Setup Node
32+
uses: actions/setup-node@v4
33+
with:
34+
node-version: 22
35+
- name: Setup Pages
36+
uses: actions/configure-pages@v3
37+
- name: Install dependencies
38+
run: npm ci
39+
- name: Build with VitePress
40+
run: |
41+
npm run docs:build
42+
touch docs/.vitepress/dist/.nojekyll
43+
- name: Upload artifact
44+
id: deployment
45+
uses: actions/upload-pages-artifact@v3
46+
with:
47+
path: docs/.vitepress/dist
48+
49+
# Deployment job
50+
deploy:
51+
needs: build
52+
permissions:
53+
pages: write
54+
id-token: write
55+
environment:
56+
name: github-pages
57+
url: ${{ steps.deployment.outputs.page_url }}
58+
runs-on: ubuntu-latest
59+
name: Deploy
60+
steps:
61+
- name: Deploy to GitHub Pages
62+
id: deployment
63+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,3 @@
1-
# This .gitignore is appropriate for repositories deployed to GitHub Pages and using
2-
# a Gemfile as specified at https://github.com/github/pages-gem#conventional
3-
4-
# Basic Jekyll gitignores (synchronize to Jekyll.gitignore)
5-
_site/
6-
.sass-cache/
7-
.jekyll-cache/
8-
.jekyll-metadata
9-
10-
# Additional Ruby/bundler ignore for when you run: bundle install
11-
/vendor
12-
13-
# Specific ignore for GitHub Pages
14-
# GitHub Pages will always use its own deployed version of pages-gem
15-
# This means GitHub Pages will NOT use your Gemfile.lock and therefore it is
16-
# counterproductive to check this file into the repository.
17-
# Details at https://github.com/github/pages-gem/issues/768
18-
Gemfile.lock
1+
node_modules
2+
docs/.vitepress/dist
3+
docs/.vitepress/cache

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
# vtk-wasm
2-
Guides and documentation around VTK.wasm
2+
3+
Guides and documentation for VTK.wasm

‎docs/.vitepress/config.mjs‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
import { defineConfig } from 'vitepress'
2+
3+
// https://vitepress.dev/reference/site-config
4+
export default defineConfig({
5+
base: "/VTK-wasm",
6+
title: "VTK.wasm",
7+
description: "Guides and documentation around VTK.wasm",
8+
lastUpdated: true,
9+
head: [
10+
['link', { rel: "apple-touch-icon", sizes: "196x196", href: "/VTK-wasm/logos/favicon-196x196.png"}],
11+
['link', { rel: "icon", type: "image/png", sizes: "32x32", href: "/VTK-wasm/logos/favicon-32x32.png"}],
12+
['link', { rel: "icon", type: "image/png", sizes: "16x16", href: "/VTK-wasm/logos/favicon-16x16.png"}],
13+
[
14+
'script',
15+
{ async: '', src: 'https://www.googletagmanager.com/gtag/js?id=G-LLSX9WG6YK' }
16+
],
17+
[
18+
'script',
19+
{},
20+
`window.dataLayer = window.dataLayer || [];
21+
function gtag(){dataLayer.push(arguments);}
22+
gtag('js', new Date());
23+
gtag('config', 'G-LLSX9WG6YK');`
24+
],
25+
],
26+
themeConfig: {
27+
// https://vitepress.dev/reference/default-theme-config
28+
nav: [
29+
{ text: 'Home', link: '/' },
30+
{ text: 'Guides', link: '/guide/' },
31+
{ text: 'Use Cases', link: '/usecase/' },
32+
{
33+
text: 'Resources',
34+
items: [
35+
{ text: 'Documentation', link: 'https://docs.paraview.org/en/latest/Catalyst/index.html' },
36+
{ text: 'Blogs', link: 'https://www.kitware.com/blog/' },
37+
{ text: 'Discussions', link: 'https://discourse.paraview.org/c/in-situ-support' },
38+
{ text: 'Issue Tracker', link: 'https://gitlab.kitware.com/groups/paraview/-/issues' },
39+
{ text: 'Webinars', link: 'https://www.kitware.com/webinars/' },
40+
{ text: 'Services', link: 'https://www.kitware.com/support' },
41+
]
42+
}
43+
],
44+
45+
sidebar: {
46+
'/guide/': [
47+
{
48+
text: 'Introduction',
49+
items: [
50+
{ text: 'Getting started', link: '/guide/index' }
51+
]
52+
},
53+
{
54+
text: 'For C++ developers',
55+
items: [
56+
{ text: 'Getting started', link: '/guide/cpp/index' },
57+
{ text: 'Tools', link: '/guide/cpp/tools' },
58+
{ text: 'Building an application', link: '/guide/cpp/app' },
59+
]
60+
},
61+
{
62+
text: 'For JavaScript developers',
63+
items: [
64+
{ text: 'Getting started', link: '/guide/js/index' },
65+
{ text: 'Built-in WASM library', link: '/guide/js/lib' },
66+
{ text: 'Building an application', link: '/guide/js/app' },
67+
]
68+
},
69+
{
70+
text: 'For trame users',
71+
items: [
72+
{ text: 'Getting started', link: '/guide/trame/index' },
73+
{ text: 'Concepts', link: '/guide/trame/concepts' },
74+
{ text: 'How to use it', link: '/guide/trame/usage' },
75+
]
76+
},
77+
],
78+
'/usecase/': [
79+
{ text: 'Examples', link: '/usecase/index' },
80+
],
81+
},
82+
83+
socialLinks: [
84+
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' }
85+
]
86+
}
87+
})

‎docs/.vitepress/theme/colors.css‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
/* https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css */
2+
:root {
3+
--vp-home-hero-name-color: #2C68C0;
4+
--vp-home-hero-name-color: transparent;
5+
--vp-home-hero-name-background: -webkit-linear-gradient(15deg, #2C68C0, #5DAC41);
6+
7+
--vp-c-brand-1: #2C68C0;
8+
--vp-c-brand-2: #5DAC41;
9+
--vp-c-sponsor: #ccc;
10+
}

‎docs/.vitepress/theme/index.js‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
// .vitepress/theme/index.js
2+
import DefaultTheme from 'vitepress/theme'
3+
import "./colors.css"
4+
5+
export default DefaultTheme;

‎docs/assets/images/tauri-wasm-widget.png‎

354 KB
Loading

‎docs/assets/images/wasm-widgets.png‎

1.11 MB
Loading

‎docs/guide/cpp/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
C++

‎docs/guide/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Guides...

0 commit comments

Comments
 (0)