Skip to content

Commit 84a797a

Browse files
committed
docs: Move docs generation from /docs to /api.
1 parent 133c823 commit 84a797a

File tree

8 files changed

+6
-9
lines changed

8 files changed

+6
-9
lines changed

packages/@css-blocks/broccoli/package.json

-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
"lintfix": "tslint -t msbuild --project . -c tslint.cli.json --fix",
2222
"coverage": "istanbul cover -i dist/src/**/*.js --dir ./build/coverage node_modules/mocha/bin/_mocha -- dist/test --opts test/mocha.opts",
2323
"remap": "remap-istanbul -i build/coverage/coverage.json -o coverage -t html",
24-
"docs": "typedoc --out ./docs .",
2524
"watch": "watch 'yarn run test' src test types-local --wait=1"
2625
},
2726
"publishConfig": {

packages/@css-blocks/core/package.json

-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
"lintfix": "tslint -t msbuild --project . -c tslint.cli.json --fix",
1515
"coverage": "istanbul cover -i \"dist/src/**/*.js\" --dir ./build/coverage node_modules/.bin/_mocha -- dist/test --opts test/mocha.opts",
1616
"remap": "remap-istanbul -i build/coverage/coverage.json -o coverage -t html",
17-
"docs": "typedoc --out ./docs .",
1817
"watch": "watch 'yarn run test' './src' './test' --wait=3"
1918
},
2019
"repository": {

packages/@css-blocks/glimmer/package.json

-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020
"lintfix": "tslint -t msbuild --project . -c tslint.cli.json --fix",
2121
"coverage": "istanbul cover -i dist/src/**/*.js --dir ./build/coverage node_modules/mocha/bin/_mocha -- dist/test --opts test/mocha.opts",
2222
"remap": "remap-istanbul -i build/coverage/coverage.json -o coverage -t html",
23-
"docs": "typedoc --out ./docs .",
2423
"watch": "watch 'yarn run test' src test types-local --wait=1"
2524
},
2625
"repository": {

packages/@css-blocks/webpack/package.json

-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
"test": "mocha dist/test --opts test/mocha.opts",
1515
"coverage": "istanbul cover -i dist/src/**/*.js --dir ./build/coverage node_modules/mocha/bin/_mocha -- dist/test --opts test/mocha.opts",
1616
"remap": "remap-istanbul -i build/coverage/coverage.json -o coverage -t html",
17-
"docs": "typedoc --out ./docs .",
1817
"watch": "watch 'yarn run test' './src' './test' --wait=3"
1918
},
2019
"repository": {

packages/@css-blocks/website/.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ npm-debug.log*
2020
yarn-debug.log*
2121
yarn-error.log*
2222

23-
public/docs
23+
public/api

packages/@css-blocks/website/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,6 @@ $ yarn run serve
2727

2828
## API Documentation
2929

30-
The API documentation is generated by Typedoc at the root of the CSS Block monorepo. When build in the monorepo's root using `yarn run docs`, the generated documentation is built to `packages/@css-blocks/website/public/docs`.
30+
The API documentation is generated by Typedoc at the root of the CSS Block monorepo. When build in the monorepo's root using `yarn run docs`, the generated documentation is built to `packages/@css-blocks/website/public/api`.
3131

3232
The custom Typedoc theme used by CSS Blocks is located at `packages/@css-blocks/website/typedocs-theme`.

packages/@css-blocks/website/src/pages/Home/index.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ class Home extends Component {
5252
className={button}
5353
>Get Started</a>
5454
<a
55-
href="/docs"
55+
href="/api"
5656
target="_blank"
5757
className={objstr({ [button]: true, [button.color("purple")]: true})}
5858
>API Documentation</a>

typedoc.js

+3-2
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,10 @@ module.exports = {
77
"./packages/@css-blocks/runtime/src",
88
"./packages/@css-blocks/webpack/src"
99
],
10-
"out": "packages/@css-blocks/website/public/docs",
10+
"out": "packages/@css-blocks/website/public/api",
1111
"mode": "modules",
1212
"theme": "packages/@css-blocks/website/typedoc-theme",
1313
"name": "@css-blocks",
14-
"external-modulemap": ".*packages\/(@css-blocks\/[^\/]+)\/.*"
14+
"external-modulemap": ".*packages\/(@css-blocks\/[^\/]+)\/.*",
15+
"readme": "./README.md"
1516
}

0 commit comments

Comments
 (0)