Skip to content

Commit bed17ac

Browse files
author
Franck Freiburger
committed
wip(docs): bump typedoc & typedoc-plugin-markdown, enhance doc formatting
1 parent 8c5e308 commit bed17ac

File tree

4 files changed

+370
-83
lines changed

4 files changed

+370
-83
lines changed

docs/api/.nojekyll

Lines changed: 0 additions & 1 deletion
This file was deleted.

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
"dev": "webpack --mode=development --config ./build/webpack.config.js --progress --watch",
5454
"build-web": "rimraf ./dist/ && cross-env-shell webpack --mode=production --config ./build/webpack.config.js --progress --env targetsBrowsers=\\\"$npm_package_browserslist\\\"",
5555
"build-node": "rollup --config ./build/rollup.config-node.mjs",
56-
"docs": "cross-env-shell \"node build/evalHtmlComments.js README.md $npm_package_version && node build/evalHtmlComments.js docs/examples.md $npm_package_version && typedoc --logLevel 1 --plugin typedoc-plugin-markdown --objectLiteralTypeDeclarationStyle list --tsconfig ./build/tsconfig.json --out ./docs/api --readme none --excludeInternal --namedAnchors true ./src/index.ts\"",
56+
"docs": "cross-env-shell \"node build/evalHtmlComments.js README.md $npm_package_version && node build/evalHtmlComments.js docs/examples.md $npm_package_version && typedoc --logLevel 1 --plugin typedoc-plugin-markdown --typeDeclarationFormat htmlTable --tsconfig ./build/tsconfig.json --out ./docs/api --readme none --excludeInternal --useHTMLAnchors true ./src/index.ts\"",
5757
"pushDocs": "yarn run docs && git add docs/ README.md && cross-env-shell git commit -m \\\"chore(docs): v$npm_package_version API docs & examples \\\" docs",
5858
"release": "standard-version --header \"\""
5959
},
@@ -102,8 +102,8 @@
102102
"terser-webpack-plugin": "^5.3.0",
103103
"ts-loader": "^9.2.6",
104104
"tslib": "^2.6.2",
105-
"typedoc": "^0.25.7",
106-
"typedoc-plugin-markdown": "^3.17.1",
105+
"typedoc": "^0.26.7",
106+
"typedoc-plugin-markdown": "^4.2.8",
107107
"typescript": "^5.3.3",
108108
"url": "^0.11.0",
109109
"util": "^0.12.4",

src/types.ts

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -211,38 +211,38 @@ export type Options = {
211211
* Sets the delimiters used for text interpolation within the template.
212212
* Typically this is used to avoid conflicting with server-side frameworks that also use mustache syntax.
213213
*
214-
* ```javascript
215-
* ...
216-
* <script>
217-
*
218-
* // <!--
219-
* const vueContent = `
220-
* <template> Hello [[[[ who ]]]] !</template>
221-
* <script>
222-
* export default {
223-
* data() {
224-
* return {
225-
* who: 'world'
226-
* }
227-
* }
228-
* }
229-
* </script>
230-
* `;
231-
* // -->
232-
*
233-
* const options = {
234-
* moduleCache: { vue: Vue },
235-
* getFile: () => vueContent,
236-
* addStyle: () => {},
237-
* delimiters: ['[[[[', ']]]]'],
238-
* }
239-
*
240-
* const app = Vue.createApp(Vue.defineAsyncComponent(() => window['vue3-sfc-loader'].loadModule('file.vue', options)));
241-
* app.mount(document.body);
242-
*
243-
* </script>
244-
* ...
245-
* ```
214+
* ```javascript
215+
* ...
216+
* <script>
217+
*
218+
* // <!--
219+
* const vueContent = `
220+
* <template> Hello [[[[ who ]]]] !</template>
221+
* <script>
222+
* export default {
223+
* data() {
224+
* return {
225+
* who: 'world'
226+
* }
227+
* }
228+
* }
229+
* </script>
230+
* `;
231+
* // -->
232+
*
233+
* const options = {
234+
* moduleCache: { vue: Vue },
235+
* getFile: () => vueContent,
236+
* addStyle: () => {},
237+
* delimiters: ['[[[[', ']]]]'],
238+
* }
239+
*
240+
* const app = Vue.createApp(Vue.defineAsyncComponent(() => window['vue3-sfc-loader'].loadModule('file.vue', options)));
241+
* app.mount(document.body);
242+
*
243+
* </script>
244+
* ...
245+
* ```
246246
*/
247247

248248
delimiters?: [string, string],

0 commit comments

Comments
 (0)