Skip to content

Commit

Permalink
wip(docs): bump typedoc & typedoc-plugin-markdown, enhance doc format…
Browse files Browse the repository at this point in the history
…ting
  • Loading branch information
Franck Freiburger committed Sep 27, 2024
1 parent 8c5e308 commit bed17ac
Show file tree
Hide file tree
Showing 4 changed files with 370 additions and 83 deletions.
1 change: 0 additions & 1 deletion docs/api/.nojekyll

This file was deleted.

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
"dev": "webpack --mode=development --config ./build/webpack.config.js --progress --watch",
"build-web": "rimraf ./dist/ && cross-env-shell webpack --mode=production --config ./build/webpack.config.js --progress --env targetsBrowsers=\\\"$npm_package_browserslist\\\"",
"build-node": "rollup --config ./build/rollup.config-node.mjs",
"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\"",
"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\"",
"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",
"release": "standard-version --header \"\""
},
Expand Down Expand Up @@ -102,8 +102,8 @@
"terser-webpack-plugin": "^5.3.0",
"ts-loader": "^9.2.6",
"tslib": "^2.6.2",
"typedoc": "^0.25.7",
"typedoc-plugin-markdown": "^3.17.1",
"typedoc": "^0.26.7",
"typedoc-plugin-markdown": "^4.2.8",
"typescript": "^5.3.3",
"url": "^0.11.0",
"util": "^0.12.4",
Expand Down
64 changes: 32 additions & 32 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -211,38 +211,38 @@ export type Options = {
* Sets the delimiters used for text interpolation within the template.
* Typically this is used to avoid conflicting with server-side frameworks that also use mustache syntax.
*
* ```javascript
* ...
* <script>
*
* // <!--
* const vueContent = `
* <template> Hello [[[[ who ]]]] !</template>
* <script>
* export default {
* data() {
* return {
* who: 'world'
* }
* }
* }
* </script>
* `;
* // -->
*
* const options = {
* moduleCache: { vue: Vue },
* getFile: () => vueContent,
* addStyle: () => {},
* delimiters: ['[[[[', ']]]]'],
* }
*
* const app = Vue.createApp(Vue.defineAsyncComponent(() => window['vue3-sfc-loader'].loadModule('file.vue', options)));
* app.mount(document.body);
*
* </script>
* ...
* ```
* ```javascript
* ...
* <script>
*
* // <!--
* const vueContent = `
* <template> Hello [[[[ who ]]]] !</template>
* <script>
* export default {
* data() {
* return {
* who: 'world'
* }
* }
* }
* </script>
* `;
* // -->
*
* const options = {
* moduleCache: { vue: Vue },
* getFile: () => vueContent,
* addStyle: () => {},
* delimiters: ['[[[[', ']]]]'],
* }
*
* const app = Vue.createApp(Vue.defineAsyncComponent(() => window['vue3-sfc-loader'].loadModule('file.vue', options)));
* app.mount(document.body);
*
* </script>
* ...
* ```
*/

delimiters?: [string, string],
Expand Down
Loading

0 comments on commit bed17ac

Please sign in to comment.