diff --git a/docs/_config.yml b/docs/_config.yml index e5326669..8529e4c5 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -18,14 +18,14 @@ # You can create any custom variable you would like, and they will be accessible # in the templates via {{ site.myvariable }}. -title: PCUI +title: PCUI email: support@playcanvas.com description: >- # this means to ignore newlines until "baseurl:" PCUI - User interface components for the web baseurl: "/pcui" # the subpath of your site, e.g. /blog url: "https://playcanvas.github.io" # the base hostname & protocol for your site, e.g. http://example.com twitter_username: playcanvas -github_username: playcanvas +github_username: playcanvas # Build settings theme: "just-the-docs" diff --git a/docs/_config_local.yml b/docs/_config_local.yml index e3f4b857..4e9c6435 100644 --- a/docs/_config_local.yml +++ b/docs/_config_local.yml @@ -18,14 +18,14 @@ # You can create any custom variable you would like, and they will be accessible # in the templates via {{ site.myvariable }}. -title: PCUI +title: PCUI email: support@playcanvas.com description: >- # this means to ignore newlines until "baseurl:" PCUI - User interface components for the web baseurl: "/" # the subpath of your site, e.g. /blog url: "http://localhost:3497" # the base hostname & protocol for your site, e.g. http://example.com twitter_username: playcanvas -github_username: playcanvas +github_username: playcanvas # Build settings theme: "just-the-docs" diff --git a/docs/pages/6-storybook.markdown b/docs/pages/6-storybook.markdown index 7184e870..021ba1b2 100644 --- a/docs/pages/6-storybook.markdown +++ b/docs/pages/6-storybook.markdown @@ -9,4 +9,4 @@ nav_order: 6 The storybook showcases all of PCUI's components in a single app. Each component can be adjusted using its documented properties. Their behavior can then be tested each components canvas. -[Click here](../storybook/) to view the storybook. \ No newline at end of file +[Click here](../storybook/) to view the storybook. diff --git a/tsconfig.json b/tsconfig.json index 77205684..975049ad 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -13,22 +13,6 @@ "sourceMap": true, "moduleResolution": "node" }, - "typedocOptions": { - "entryPoints": ["./src/index.ts"], - "githubPages": false, - "name": "PCUI API", - "navigationLinks": { - "Developer Site": "https://developer.playcanvas.com/", - "Discord": "https://discord.gg/RSaMRzg", - "Forum": "https://forum.playcanvas.com/", - "GitHub": "https://github.com/playcanvas/pcui" - }, - "out": "typedocs", - "plugin": [ - "typedoc-plugin-mdn-links" - ], - "readme": "none" - }, "include": ["./src/index.ts"], "exclude": ["node_modules/**/*", "node_modules"] } diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 00000000..87658140 --- /dev/null +++ b/typedoc.json @@ -0,0 +1,16 @@ +{ + "entryPoints": ["./src/index.ts"], + "githubPages": false, + "name": "PCUI API", + "navigationLinks": { + "Developer Site": "https://developer.playcanvas.com/", + "Discord": "https://discord.gg/RSaMRzg", + "Forum": "https://forum.playcanvas.com/", + "GitHub": "https://github.com/playcanvas/pcui" + }, + "out": "typedocs", + "plugin": [ + "typedoc-plugin-mdn-links" + ], + "readme": "none" +}