From dadf29733fc0f59abd56b1b8954f2d444e5c60cb Mon Sep 17 00:00:00 2001 From: Dominic Garms Date: Fri, 7 Mar 2025 10:42:27 +0800 Subject: [PATCH] Update README.md --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d65aae5..8c60419 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,12 @@ +# Important announcement +The dev team of Storyblok have seen the importance to have a working CLI as part of their infrastructure. So please check out following resources: + +* https://github.com/storyblok/storyblok-cli?tab=readme-ov-file#generate-typescript-typedefs +* https://www.storyblok.com/faq/how-can-i-utilize-typescript-in-my-storyblok-project +* https://dev.to/storyblok/generate-types-for-your-components-with-the-storyblok-cli-14b7 + +On newer projects its probably better on the long run using the official CLI. + # storyblok-generate-ts This plugin uses [json-schema-to-typescript](https://github.com/bcherny/json-schema-to-typescript) to generate TS types based on `Storyblok` components. You can install and run it as a CLI script @@ -182,4 +191,4 @@ type PageWithRelations = PageStoryblok & { * 1.13.2 Fixed types * 1.14.0 Enable multi-file support and add RichText typings (thanks to @VictorWinberg & @mattcrn) * 1.15.0 Change Storyblok number type to "string" as the API does not return a number type (thanks to @davidhoeck) -* 2.0.0 Change of use of camelcase: now every title is used with camelcase which potentially breaks existing type names but fixes inconsistency \ No newline at end of file +* 2.0.0 Change of use of camelcase: now every title is used with camelcase which potentially breaks existing type names but fixes inconsistency