Skip to content

Commit dc3176f

Browse files
abichingerabichinger
committed
docs: add links to typedoc
1 parent 34adf74 commit dc3176f

28 files changed

+181
-63
lines changed

‎ant/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,16 @@
1313
<a href="https://www.npmjs.com/package/@vue-js-cron/vuetify">Vuetify</a>
1414
</p>
1515

16-
## Usage - Ant
16+
## Links - Ant
1717

1818
[Demo](https://abichinger.github.io/vue-js-cron/demo.html)
1919

2020
[Get Started](https://abichinger.github.io/vue-js-cron/guide/getting-started-ant)
2121

22-
[API - cron-ant](https://abichinger.github.io/vue-js-cron/api/ant.html)
22+
[CronAnt API](https://abichinger.github.io/vue-js-cron/typedoc/classes/_vue_js_cron_ant.CronAnt)
23+
24+
[CronAntProps API](https://abichinger.github.io/vue-js-cron/typedoc/interfaces/_vue_js_cron_ant.CronAntProps)
25+
2326

2427
## Attribution
2528

‎core/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,16 @@
1313
<a href="https://www.npmjs.com/package/@vue-js-cron/vuetify">Vuetify</a>
1414
</p>
1515

16-
## Usage - Core
16+
## Links - Core
1717

1818
[Demo](https://abichinger.github.io/vue-js-cron/demo.html)
1919

2020
[Get Started](https://abichinger.github.io/vue-js-cron/guide/getting-started-core)
2121

22-
[API - cron-core](https://abichinger.github.io/vue-js-cron/api/core.html)
22+
[CronCore API](https://abichinger.github.io/vue-js-cron/typedoc/classes/_vue_js_cron_core.CronCore)
23+
24+
[CronCoreProps API](https://abichinger.github.io/vue-js-cron/typedoc/interfaces/_vue_js_cron_core.CronCoreProps)
25+
2326

2427
## Attribution
2528

‎docs/src/guide/getting-started-ant.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,16 @@ Done! 🚀
4545

4646
<br />
4747

48+
## API
49+
50+
51+
[CronAnt API](https://abichinger.github.io/vue-js-cron/typedoc/classes/_vue_js_cron_ant.CronAnt)
52+
53+
[CronAntProps API](https://abichinger.github.io/vue-js-cron/typedoc/interfaces/_vue_js_cron_ant.CronAntProps)
54+
55+
56+
57+
4858
## Example
4959

5060
@[code](../.vuepress/components/get-started-ant.vue)

‎docs/src/guide/getting-started-core.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,16 @@ Done! 🚀
4040

4141
<br />
4242

43+
## API
44+
45+
46+
[CronCore API](https://abichinger.github.io/vue-js-cron/typedoc/classes/_vue_js_cron_core.CronCore)
47+
48+
[CronCoreProps API](https://abichinger.github.io/vue-js-cron/typedoc/interfaces/_vue_js_cron_core.CronCoreProps)
49+
50+
51+
52+
4353
## Example
4454

4555
@[code](../.vuepress/components/get-started-renderless.vue)

‎docs/src/guide/getting-started-element-plus.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,16 @@ Done! 🚀
4545

4646
<br />
4747

48+
## API
49+
50+
51+
[CronElementPlus API](https://abichinger.github.io/vue-js-cron/typedoc/classes/_vue_js_cron_element_plus.CronElementPlus)
52+
53+
[CronElementPlusProps API](https://abichinger.github.io/vue-js-cron/typedoc/interfaces/_vue_js_cron_element_plus.CronElementPlusProps)
54+
55+
56+
57+
4858
## Example
4959

5060
@[code](../.vuepress/components/get-started-element.vue)

‎docs/src/guide/getting-started-light.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,16 @@ Done! 🚀
4141

4242
<br />
4343

44+
## API
45+
46+
47+
[CronLight API](https://abichinger.github.io/vue-js-cron/typedoc/classes/_vue_js_cron_light.CronLight)
48+
49+
[CronLightProps API](https://abichinger.github.io/vue-js-cron/typedoc/interfaces/_vue_js_cron_light.CronLightProps)
50+
51+
52+
53+
4454
## Example
4555

4656
@[code](../.vuepress/components/get-started-light.vue)

‎docs/src/guide/getting-started-quasar.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,13 @@ app.component('CronQuasar', CronQuasar)
4242

4343
Done! 🚀
4444

45-
<br />
45+
<br />
46+
47+
## API
48+
49+
50+
[CronQuasar API](https://abichinger.github.io/vue-js-cron/typedoc/classes/_vue_js_cron_quasar.CronQuasar)
51+
52+
[CronQuasarProps API](https://abichinger.github.io/vue-js-cron/typedoc/interfaces/_vue_js_cron_quasar.CronQuasarProps)
53+
54+

‎docs/src/guide/getting-started-vuetify.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,16 @@ Done! 🚀
4545

4646
<br />
4747

48+
## API
49+
50+
51+
[CronVuetify API](https://abichinger.github.io/vue-js-cron/typedoc/classes/_vue_js_cron_vuetify.CronVuetify)
52+
53+
[CronVuetifyProps API](https://abichinger.github.io/vue-js-cron/typedoc/interfaces/_vue_js_cron_vuetify.CronVuetifyProps)
54+
55+
56+
57+
4858
## Example
4959

5060
@[code](../.vuepress/components/get-started-vuetify.vue)

‎element-plus/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,16 @@
1313
<a href="https://www.npmjs.com/package/@vue-js-cron/vuetify">Vuetify</a>
1414
</p>
1515

16-
## Usage - Element Plus
16+
## Links - Element Plus
1717

1818
[Demo](https://abichinger.github.io/vue-js-cron/demo.html)
1919

2020
[Get Started](https://abichinger.github.io/vue-js-cron/guide/getting-started-element-plus)
2121

22-
[API - cron-element-plus](https://abichinger.github.io/vue-js-cron/api/element-plus.html)
22+
[CronElementPlus API](https://abichinger.github.io/vue-js-cron/typedoc/classes/_vue_js_cron_element_plus.CronElementPlus)
23+
24+
[CronElementPlusProps API](https://abichinger.github.io/vue-js-cron/typedoc/interfaces/_vue_js_cron_element_plus.CronElementPlusProps)
25+
2326

2427
## Attribution
2528

‎generated/bin/flavors.d.ts

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import type { App } from 'vue';
2-
export interface Requirement {
2+
export interface Link {
33
name: string;
44
url: string;
55
}
@@ -14,13 +14,8 @@ export interface Flavor {
1414
uses?: Record<string, string[]>;
1515
imports?: string[];
1616
setup?: (app: App) => Promise<void>;
17-
requirements?: Requirement[];
17+
requirements?: Link[];
1818
example?: string;
19+
api?: Link[];
1920
}
20-
export declare const core: Flavor;
21-
export declare const light: Flavor;
22-
export declare const ant: Flavor;
23-
export declare const element: Flavor;
24-
export declare const quasar: Flavor;
25-
export declare const vuetify: Flavor;
2621
export declare const flavors: Flavor[];

‎generated/bin/flavors.js

Lines changed: 20 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎generated/bin/flavors.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎generated/bin/guide.js

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎generated/bin/guide.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎generated/bin/readme.js

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎generated/bin/readme.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎generated/bin/templates/README.md.njk

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,14 @@
1111
{%- endfor %}
1212
</p>
1313

14-
## Usage - {{ flavor.name }}
14+
## Links - {{ flavor.name }}
1515

16-
[Demo](https://abichinger.github.io/vue-js-cron/demo.html)
16+
[Demo]({{ baseUrl }}/demo.html)
1717

18-
[Get Started](https://abichinger.github.io/vue-js-cron/guide/getting-started-{{ flavor.dir }})
19-
20-
[API - cron-{{ flavor.dir }}](https://abichinger.github.io/vue-js-cron/api/{{ flavor.dir }}.html)
18+
[Get Started]({{ baseUrl }}/guide/getting-started-{{ flavor.dir }})
19+
{% for link in flavor.api %}
20+
[{{ link.name }}]({{ baseUrl }}{{ link.url }})
21+
{% endfor %}
2122

2223
## Attribution
2324

‎generated/bin/templates/getting-started.md.njk

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,13 @@ Done! 🚀
5555

5656
<br />
5757

58-
{%- if flavor.example %}
58+
## API
59+
60+
{% for link in flavor.api %}
61+
[{{ link.name }}]({{ baseUrl }}{{ link.url }})
62+
{% endfor %}
63+
64+
{% if flavor.example %}
5965

6066
## Example
6167

‎generated/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
},
2222
"devDependencies": {
2323
"@types/argparse": "^2.0.12",
24-
"typescript": "^5.2.2",
25-
"copyfiles": "^2.4.1"
24+
"copyfiles": "^2.4.1",
25+
"typescript": "^5.2.2"
2626
}
2727
}

0 commit comments

Comments
 (0)