update and add website docs

pixijs · Jan 8, 2025 · 4fb3f54 · 4fb3f54
1 parent 77fc7a1
commit 4fb3f54
Show file tree

Hide file tree

Showing 11 changed files with 25 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -63,7 +63,7 @@ Currently supported template presets include:
 - `bundler-esbuild`
 - `bundler-import-map`
 - `creation-web`
-- `creation-extension`
+- `extension-default`
 
 You can use `.` for the project name to scaffold in the current directory.
 

diff --git a/docs/docs/guide/installation.mdx b/docs/docs/guide/installation.mdx
@@ -63,6 +63,13 @@ Currently supported creation templates include:
 - **[Facebook Template](https://www.facebook.com/fbgaminghome/developers)**: Create apps for Facebook Instant Games.
 - **[YouTube Template](https://developers.google.com/youtube/gaming/playables/reference/sdk)**: Develop YouTube Playables.
 
+## Extension Templates
+
+Extension templates are designed for creating libraries and plugins that enhance PixiJS functionality, such as custom filters or plugins that introduce new features.
+
+These templates leverage [PixiJS ExtensionScript](https://github.com/pixijs/extension-scripts), a CLI tool that simplifies the development process for building PixiJS-compatible extensions. To get the most out of this tool, we recommend reviewing the ExtensionScript documentation.
+
+These templates are best suited for experienced developers familiar with PixiJS and common development toolchains.
 
 ## Advanced Usage
 
@@ -91,6 +98,7 @@ You can use `.` for the project name to scaffold in the current directory.
 - `bundler-esbuild`
 - `bundler-import-map`
 - `creation-web`
+- `extension-default`
 
 ## License
 

diff --git a/src/index.ts b/src/index.ts
@@ -37,7 +37,7 @@ ${blueBright('Webpack:                  bundler-webpack'     )}
 ${yellow    ('esbuild:                  bundler-esbuild'     )}
 ${green     ('Import Map:               bundler-import-map'  )}
 ${cyan      ('Web Creation App:         creation-web'        )}
-${blueBright('Extension:                creaction-extension' )}
+${blueBright('Extension:                extension-default'   )}
 
 Coming soon:
 ${blue      ('Discord Creation App:     creation-discord'    )}
@@ -96,11 +96,6 @@ const FRAMEWORKS: Framework[] = [
         display: "Web",
         color: yellow,
       },
-      {
-        name: "creation-extension",
-        display: "Extension",
-        color: blueBright,
-      },
       // {
       //   name: "creation-discord",
       //   display: "Discord",
@@ -118,6 +113,18 @@ const FRAMEWORKS: Framework[] = [
       // },
     ],
   },
+  {
+    name: "extension",
+    display: "Extension",
+    color: blueBright,
+    variants: [
+      {
+        name: "extension-default",
+        display: "Default",
+        color: blue,
+      },
+    ],
+  },
 ];
 
 const TEMPLATES = FRAMEWORKS.map(

diff --git a/...lates/template-creation-extension/LICENSE → templates/template-extension-default/LICENSE b/...lates/template-creation-extension/LICENSE → templates/template-extension-default/LICENSE
diff --git a/...tes/template-creation-extension/README.md → ...ates/template-extension-default/README.md b/...tes/template-creation-extension/README.md → ...ates/template-extension-default/README.md
diff --git a/...es/template-creation-extension/_gitignore → ...tes/template-extension-default/_gitignore b/...es/template-creation-extension/_gitignore → ...tes/template-extension-default/_gitignore
diff --git a/...te-creation-extension/examples/index.html → ...ate-extension-default/examples/index.html b/...te-creation-extension/examples/index.html → ...ate-extension-default/examples/index.html
diff --git a/.../template-creation-extension/package.json → ...s/template-extension-default/package.json b/.../template-creation-extension/package.json → ...s/template-extension-default/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "template-creation-extension",
+  "name": "template-extension",
   "version": "1.0.0",
   "description": "[Description of extension]",
   "author": "[Author's name]",
@@ -14,11 +14,11 @@
     }
   },
   "homepage": "https://pixijs.com/",
-  "bugs": "https://github.com/pixijs-userland/template-creation-extension/issues",
+  "bugs": "https://github.com/pixijs-userland/template-extension/issues",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/pixijs-userland/template-creation-extension.git"
+    "url": "https://github.com/pixijs-userland/template-extension.git"
   },
   "scripts": {
     "dev": "xs serve",

diff --git a/...extension/src/__tests__/Rectangle.test.ts → ...n-default/src/__tests__/Rectangle.test.ts b/...extension/src/__tests__/Rectangle.test.ts → ...n-default/src/__tests__/Rectangle.test.ts
diff --git a/.../template-creation-extension/src/index.ts → ...s/template-extension-default/src/index.ts b/.../template-creation-extension/src/index.ts → ...s/template-extension-default/src/index.ts
diff --git a/...template-creation-extension/tsconfig.json → .../template-extension-default/tsconfig.json b/...template-creation-extension/tsconfig.json → .../template-extension-default/tsconfig.json