Skip to content

Commit 31713a4

Browse files
committed
chore(docs): bundle doc outputs into demo deploy
1 parent 3cd1108 commit 31713a4

File tree

6 files changed

+8
-5
lines changed

6 files changed

+8
-5
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,4 @@ stats.json
3737
dist
3838
lib
3939
demo/build
40+
demo/public/docs

demo/.prettierrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"parser": "typescript",
99
"overrides": [
1010
{
11-
"files": "*.yaml",
11+
"files": "*.yml",
1212
"options": { "parser": "yaml" }
1313
},
1414
{

demo/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
"build": "react-scripts build",
2020
"test": "react-scripts test",
2121
"eject": "react-scripts eject",
22-
"predeploy": "npm run build",
2322
"deploy": "gh-pages -d build"
2423
},
2524
"eslintConfig": {

demo/public/_config.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# We need this to allow GH Pages to include underscore-prefixed Typedoc pages.
2+
include:
3+
- '_*_.html'
4+
- '_*_.*.html'

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
"coveralls": "cat ./coverage/lcov.info | coveralls",
2424
"show:cov": "open coverage/lcov-report/index.html",
2525
"show:docs": "open docs/index.html",
26-
"release": "npm run test && npm run build && npm run docs && git commit -a"
26+
"deploy:demo": "npm run build:docs && cd demo && npm run build && npm run deploy"
2727
},
2828
"repository": {
2929
"type": "git",

typedoc.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
"inputFiles": ["./src"],
33
"exclude": ["**/tests/*", "**/*.test.js"],
44
"mode": "modules",
5-
"out": "docs",
6-
"readme": "none",
5+
"out": "demo/public/docs",
76
"includeVersion": true
87
}

0 commit comments

Comments
 (0)