Skip to content

Commit a5a0364

Browse files
triniwiztriniwiz
committed
init
0 parents  commit a5a0364

60 files changed

Lines changed: 17824 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/deploy.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Deploy to Cloudflare Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- main
10+
11+
jobs:
12+
deploy:
13+
runs-on: ubuntu-latest
14+
permissions:
15+
contents: read
16+
deployments: write
17+
name: Deploy to Cloudflare Pages
18+
19+
steps:
20+
- name: Checkout
21+
uses: actions/checkout@v4
22+
23+
- name: Setup Node.js
24+
uses: actions/setup-node@v4
25+
with:
26+
node-version: '20'
27+
cache: 'npm'
28+
29+
- name: Install dependencies
30+
run: npm ci
31+
32+
- name: Build VitePress site
33+
run: npm run build
34+
35+
- name: Deploy to Cloudflare Pages
36+
uses: cloudflare/wrangler-action@v3
37+
with:
38+
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
39+
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
40+
command: pages deploy .vitepress/dist --project-name=plugins-nstudio-io

‎.gitignore‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Dependencies
2+
node_modules/
3+
4+
# Build output
5+
.vitepress/dist/
6+
.vitepress/cache/
7+
dist/
8+
9+
# Logs
10+
logs
11+
*.log
12+
npm-debug.log*
13+
yarn-debug.log*
14+
yarn-error.log*
15+
pnpm-debug.log*
16+
17+
# Editor directories and files
18+
.idea/
19+
.vscode/*
20+
!.vscode/extensions.json
21+
!.vscode/settings.json
22+
*.suo
23+
*.ntvs*
24+
*.njsproj
25+
*.sln
26+
*.sw?
27+
28+
# OS files
29+
.DS_Store
30+
Thumbs.db
31+
32+
# Environment files
33+
.env
34+
.env.*
35+
!.env.example
36+
37+
# Local development
38+
*.local

‎.vitepress-dev.pid‎

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

‎.vitepress/config.ts‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
import { defineConfig } from 'vitepress';
2+
3+
// https://vitepress.dev/reference/site-config
4+
export default defineConfig({
5+
lang: 'en-US',
6+
title: 'NativeScript Packages',
7+
description: 'Documentation for NativeScript canvas ecosystem packages, including @nativescript/canvas and @nativescript/audio-context.',
8+
9+
srcDir: './content',
10+
cleanUrls: true,
11+
appearance: true,
12+
13+
markdown: {
14+
theme: {
15+
light: 'github-light',
16+
dark: 'github-dark',
17+
},
18+
lineNumbers: false,
19+
},
20+
21+
head: [
22+
['link', { rel: 'icon', type: 'image/svg+xml', href: '/logo.svg' }],
23+
['meta', { name: 'theme-color', content: '#F75930' }],
24+
['meta', { property: 'og:type', content: 'website' }],
25+
['meta', { property: 'og:site_name', content: 'NativeScript Canvas Packages' }],
26+
['meta', { property: 'og:title', content: 'NativeScript Canvas Packages' }],
27+
['meta', { property: 'og:description', content: 'Documentation for @nativescript/canvas, @nativescript/audio-context, and related NativeScript canvas ecosystem packages.' }],
28+
['meta', { property: 'og:image', content: 'https://plugins.nstudio.io/nstudio-plugins-meta.png' }],
29+
['meta', { property: 'og:image:width', content: '1200' }],
30+
['meta', { property: 'og:image:height', content: '630' }],
31+
['meta', { property: 'og:url', content: 'https://plugins.nstudio.io' }],
32+
['meta', { name: 'twitter:card', content: 'summary_large_image' }],
33+
['meta', { name: 'twitter:title', content: 'NativeScript Canvas Packages' }],
34+
['meta', { name: 'twitter:description', content: 'Documentation for @nativescript/canvas, @nativescript/audio-context, and related NativeScript canvas ecosystem packages.' }],
35+
['meta', { name: 'twitter:image', content: 'https://plugins.nstudio.io/nstudio-plugins-meta.png' }],
36+
['link', { rel: 'preconnect', href: 'https://fonts.googleapis.com' }],
37+
['link', { rel: 'preconnect', href: 'https://fonts.gstatic.com', crossorigin: '' }],
38+
['link', { href: 'https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700;800&display=swap', rel: 'stylesheet' }],
39+
],
40+
41+
themeConfig: {
42+
logo: '/logo.svg',
43+
44+
nav: [
45+
{ text: 'Home', link: '/' },
46+
{ text: 'Playground', link: '/canvas-playground/' },
47+
{ text: 'Canvas', link: '/canvas/' },
48+
{ text: 'Audio Context', link: '/audio-context/' },
49+
{ text: 'Packages', link: '/plugins/' },
50+
{ text: 'GitHub', link: 'https://github.com/NativeScript/canvas' },
51+
],
52+
53+
sidebar: {
54+
'/plugins/': [
55+
{
56+
text: 'Canvas Repository Packages',
57+
items: [
58+
{ text: 'Overview', link: '/plugins/' },
59+
{ text: '@nativescript/canvas', link: '/canvas/' },
60+
{ text: '@nativescript/audio-context', link: '/audio-context/' },
61+
{ text: '@nativescript/canvas-polyfill', link: 'https://github.com/NativeScript/canvas/tree/master/packages/canvas-polyfill/README.md' },
62+
{ text: '@nativescript/canvas-media', link: 'https://github.com/NativeScript/canvas/tree/master/packages/canvas-media/README.md' },
63+
{ text: '@nativescript/canvas-three', link: 'https://github.com/NativeScript/canvas/tree/master/packages/canvas-three/README.md' },
64+
{ text: '@nativescript/canvas-pixi', link: 'https://github.com/NativeScript/canvas/tree/master/packages/canvas-pixi/README.md' },
65+
{ text: '@nativescript/canvas-phaser', link: 'https://github.com/NativeScript/canvas/tree/master/packages/canvas-phaser/README.md' },
66+
{ text: '@nativescript/canvas-phaser-ce', link: 'https://github.com/NativeScript/canvas/tree/master/packages/canvas-phaser-ce/README.md' },
67+
{ text: '@nativescript/canvas-svg', link: 'https://github.com/NativeScript/canvas/tree/master/packages/canvas-svg/README.md' },
68+
{ text: '@nativescript/canvas-chartjs', link: 'https://github.com/NativeScript/canvas/tree/master/packages/canvas-chartjs/README.md' },
69+
{ text: '@nativescript/canvas-babylon', link: 'https://github.com/NativeScript/canvas/tree/master/packages/canvas-babylon/README.md' },
70+
],
71+
},
72+
],
73+
'/canvas/': [
74+
{
75+
text: 'Getting Started',
76+
items: [
77+
{ text: 'Introduction', link: '/canvas/' },
78+
{ text: 'Installation', link: '/canvas/installation' },
79+
{ text: 'Quick Start', link: '/canvas/quick-start' },
80+
],
81+
},
82+
{
83+
text: 'Guides',
84+
items: [
85+
{ text: 'Web API Samples', link: '/canvas/guides/web-api-samples' },
86+
{ text: 'Canvas 2D Recipes', link: '/canvas/guides/canvas-2d-recipes' },
87+
{ text: 'WebGL Recipes', link: '/canvas/guides/webgl-recipes' },
88+
{ text: 'WebGPU Recipes', link: '/canvas/guides/webgpu-recipes' },
89+
{ text: 'Rendering Contexts', link: '/canvas/rendering-contexts' },
90+
{ text: 'API Overview', link: '/canvas/api' },
91+
{ text: 'Ecosystem Packages', link: '/canvas/ecosystem' },
92+
],
93+
},
94+
],
95+
'/audio-context/': [
96+
{
97+
text: 'Getting Started',
98+
items: [
99+
{ text: 'Introduction', link: '/audio-context/' },
100+
{ text: 'Installation', link: '/audio-context/installation' },
101+
{ text: 'Quick Start', link: '/audio-context/quick-start' },
102+
],
103+
},
104+
{
105+
text: 'Guides',
106+
items: [
107+
{ text: 'Web API Samples', link: '/audio-context/guides/web-api-samples' },
108+
{ text: 'Dynamics Compression', link: '/audio-context/guides/dynamics-compression' },
109+
{ text: 'Routing and Mixing', link: '/audio-context/guides/routing-and-mixing' },
110+
{ text: 'Decode and Play Audio', link: '/audio-context/guides/decode-and-play' },
111+
{ text: 'Media Element Source', link: '/audio-context/guides/media-element-source' },
112+
{ text: 'Offline Rendering', link: '/audio-context/guides/offline-rendering' },
113+
],
114+
},
115+
{
116+
text: 'Reference',
117+
items: [
118+
{ text: 'Supported API Surface', link: '/audio-context/api-surface' },
119+
],
120+
},
121+
],
122+
},
123+
124+
socialLinks: [
125+
{ icon: 'github', link: 'https://github.com/NativeScript/canvas' },
126+
],
127+
128+
// footer: {
129+
// // message: 'Released under the Apache-2.0 License.',
130+
// copyright: `Copyright © ${new Date().getFullYear()} nStudio`,
131+
// },
132+
133+
search: {
134+
provider: 'local',
135+
},
136+
},
137+
});

0 commit comments

Comments
 (0)