Skip to content

Commit

Permalink
Split out typedoc config
Browse files Browse the repository at this point in the history
  • Loading branch information
willeastcott committed Feb 4, 2024
1 parent 6006f78 commit 660e517
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 21 deletions.
4 changes: 2 additions & 2 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: [email protected]
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"
Expand Down
4 changes: 2 additions & 2 deletions docs/_config_local.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: [email protected]
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"
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/6-storybook.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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.
[Click here](../storybook/) to view the storybook.
16 changes: 0 additions & 16 deletions tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
}
16 changes: 16 additions & 0 deletions typedoc.json
Original file line number Diff line number Diff line change
@@ -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"
}

0 comments on commit 660e517

Please sign in to comment.