docs: add links to typedoc

abichinger · Nov 14, 2023 · dc3176f · dc3176f
1 parent 34adf74
commit dc3176f
Show file tree

Hide file tree

Showing 28 changed files with 181 additions and 63 deletions.
diff --git a/ant/README.md b/ant/README.md
@@ -13,13 +13,16 @@
 <a href="https://www.npmjs.com/package/@vue-js-cron/vuetify">Vuetify</a>
 </p>
 
-## Usage - Ant
+## Links - Ant
 
 [Demo](https://abichinger.github.io/vue-js-cron/demo.html)
 
 [Get Started](https://abichinger.github.io/vue-js-cron/guide/getting-started-ant)
 
-[API - cron-ant](https://abichinger.github.io/vue-js-cron/api/ant.html)
+[CronAnt API](https://abichinger.github.io/vue-js-cron/typedoc/classes/_vue_js_cron_ant.CronAnt)
+
+[CronAntProps API](https://abichinger.github.io/vue-js-cron/typedoc/interfaces/_vue_js_cron_ant.CronAntProps)
+
 
 ## Attribution
 

diff --git a/core/README.md b/core/README.md
@@ -13,13 +13,16 @@
 <a href="https://www.npmjs.com/package/@vue-js-cron/vuetify">Vuetify</a>
 </p>
 
-## Usage - Core
+## Links - Core
 
 [Demo](https://abichinger.github.io/vue-js-cron/demo.html)
 
 [Get Started](https://abichinger.github.io/vue-js-cron/guide/getting-started-core)
 
-[API - cron-core](https://abichinger.github.io/vue-js-cron/api/core.html)
+[CronCore API](https://abichinger.github.io/vue-js-cron/typedoc/classes/_vue_js_cron_core.CronCore)
+
+[CronCoreProps API](https://abichinger.github.io/vue-js-cron/typedoc/interfaces/_vue_js_cron_core.CronCoreProps)
+
 
 ## Attribution
 

diff --git a/docs/src/guide/getting-started-ant.md b/docs/src/guide/getting-started-ant.md
@@ -45,6 +45,16 @@ Done! 🚀
 
 <br />
 
+## API
+
+
+[CronAnt API](https://abichinger.github.io/vue-js-cron/typedoc/classes/_vue_js_cron_ant.CronAnt)
+
+[CronAntProps API](https://abichinger.github.io/vue-js-cron/typedoc/interfaces/_vue_js_cron_ant.CronAntProps)
+
+
+
+
 ## Example
 
 @[code](../.vuepress/components/get-started-ant.vue)
diff --git a/docs/src/guide/getting-started-core.md b/docs/src/guide/getting-started-core.md
@@ -40,6 +40,16 @@ Done! 🚀
 
 <br />
 
+## API
+
+
+[CronCore API](https://abichinger.github.io/vue-js-cron/typedoc/classes/_vue_js_cron_core.CronCore)
+
+[CronCoreProps API](https://abichinger.github.io/vue-js-cron/typedoc/interfaces/_vue_js_cron_core.CronCoreProps)
+
+
+
+
 ## Example
 
 @[code](../.vuepress/components/get-started-renderless.vue)
diff --git a/docs/src/guide/getting-started-element-plus.md b/docs/src/guide/getting-started-element-plus.md
@@ -45,6 +45,16 @@ Done! 🚀
 
 <br />
 
+## API
+
+
+[CronElementPlus API](https://abichinger.github.io/vue-js-cron/typedoc/classes/_vue_js_cron_element_plus.CronElementPlus)
+
+[CronElementPlusProps API](https://abichinger.github.io/vue-js-cron/typedoc/interfaces/_vue_js_cron_element_plus.CronElementPlusProps)
+
+
+
+
 ## Example
 
 @[code](../.vuepress/components/get-started-element.vue)
diff --git a/docs/src/guide/getting-started-light.md b/docs/src/guide/getting-started-light.md
@@ -41,6 +41,16 @@ Done! 🚀
 
 <br />
 
+## API
+
+
+[CronLight API](https://abichinger.github.io/vue-js-cron/typedoc/classes/_vue_js_cron_light.CronLight)
+
+[CronLightProps API](https://abichinger.github.io/vue-js-cron/typedoc/interfaces/_vue_js_cron_light.CronLightProps)
+
+
+
+
 ## Example
 
 @[code](../.vuepress/components/get-started-light.vue)
diff --git a/docs/src/guide/getting-started-quasar.md b/docs/src/guide/getting-started-quasar.md
@@ -42,4 +42,13 @@ app.component('CronQuasar', CronQuasar)
 
 Done! 🚀
 
-<br />
+<br />
+
+## API
+
+
+[CronQuasar API](https://abichinger.github.io/vue-js-cron/typedoc/classes/_vue_js_cron_quasar.CronQuasar)
+
+[CronQuasarProps API](https://abichinger.github.io/vue-js-cron/typedoc/interfaces/_vue_js_cron_quasar.CronQuasarProps)
+
+
diff --git a/docs/src/guide/getting-started-vuetify.md b/docs/src/guide/getting-started-vuetify.md
@@ -45,6 +45,16 @@ Done! 🚀
 
 <br />
 
+## API
+
+
+[CronVuetify API](https://abichinger.github.io/vue-js-cron/typedoc/classes/_vue_js_cron_vuetify.CronVuetify)
+
+[CronVuetifyProps API](https://abichinger.github.io/vue-js-cron/typedoc/interfaces/_vue_js_cron_vuetify.CronVuetifyProps)
+
+
+
+
 ## Example
 
 @[code](../.vuepress/components/get-started-vuetify.vue)
diff --git a/element-plus/README.md b/element-plus/README.md
@@ -13,13 +13,16 @@
 <a href="https://www.npmjs.com/package/@vue-js-cron/vuetify">Vuetify</a>
 </p>
 
-## Usage - Element Plus
+## Links - Element Plus
 
 [Demo](https://abichinger.github.io/vue-js-cron/demo.html)
 
 [Get Started](https://abichinger.github.io/vue-js-cron/guide/getting-started-element-plus)
 
-[API - cron-element-plus](https://abichinger.github.io/vue-js-cron/api/element-plus.html)
+[CronElementPlus API](https://abichinger.github.io/vue-js-cron/typedoc/classes/_vue_js_cron_element_plus.CronElementPlus)
+
+[CronElementPlusProps API](https://abichinger.github.io/vue-js-cron/typedoc/interfaces/_vue_js_cron_element_plus.CronElementPlusProps)
+
 
 ## Attribution
 

diff --git a/generated/bin/flavors.d.ts b/generated/bin/flavors.d.ts
@@ -1,5 +1,5 @@
 import type { App } from 'vue';
-export interface Requirement {
+export interface Link {
     name: string;
     url: string;
 }
@@ -14,13 +14,8 @@ export interface Flavor {
     uses?: Record<string, string[]>;
     imports?: string[];
     setup?: (app: App) => Promise<void>;
-    requirements?: Requirement[];
+    requirements?: Link[];
     example?: string;
+    api?: Link[];
 }
-export declare const core: Flavor;
-export declare const light: Flavor;
-export declare const ant: Flavor;
-export declare const element: Flavor;
-export declare const quasar: Flavor;
-export declare const vuetify: Flavor;
 export declare const flavors: Flavor[];
diff --git a/generated/bin/flavors.js b/generated/bin/flavors.js
diff --git a/generated/bin/flavors.js.map b/generated/bin/flavors.js.map
diff --git a/generated/bin/guide.js b/generated/bin/guide.js
diff --git a/generated/bin/guide.js.map b/generated/bin/guide.js.map
diff --git a/generated/bin/readme.js b/generated/bin/readme.js
diff --git a/generated/bin/readme.js.map b/generated/bin/readme.js.map
diff --git a/generated/bin/templates/README.md.njk b/generated/bin/templates/README.md.njk
@@ -11,13 +11,14 @@
 {%- endfor %}
 </p>
 
-## Usage - {{ flavor.name }}
+## Links - {{ flavor.name }}
 
-[Demo](https://abichinger.github.io/vue-js-cron/demo.html)
+[Demo]({{ baseUrl }}/demo.html)
 
-[Get Started](https://abichinger.github.io/vue-js-cron/guide/getting-started-{{ flavor.dir }})
-
-[API - cron-{{ flavor.dir }}](https://abichinger.github.io/vue-js-cron/api/{{ flavor.dir }}.html)
+[Get Started]({{ baseUrl }}/guide/getting-started-{{ flavor.dir }})
+{% for link in flavor.api %}
+[{{ link.name }}]({{ baseUrl }}{{ link.url }})
+{% endfor %}
 
 ## Attribution
 

diff --git a/generated/bin/templates/getting-started.md.njk b/generated/bin/templates/getting-started.md.njk
@@ -55,7 +55,13 @@ Done! 🚀
 
 <br />
 
-{%- if flavor.example %}
+## API
+
+{% for link in flavor.api %}
+[{{ link.name }}]({{ baseUrl }}{{ link.url }})
+{% endfor %}
+
+{% if flavor.example %}
 
 ## Example
 

diff --git a/generated/package.json b/generated/package.json
@@ -21,7 +21,7 @@
   },
   "devDependencies": {
     "@types/argparse": "^2.0.12",
-    "typescript": "^5.2.2",
-    "copyfiles": "^2.4.1"
+    "copyfiles": "^2.4.1",
+    "typescript": "^5.2.2"
   }
 }