Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dohomi authored Mar 7, 2025
1 parent 0b7f7f5 commit dadf297
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
* 2.0.0 Change of use of camelcase: now every title is used with camelcase which potentially breaks existing type names but fixes inconsistency

0 comments on commit dadf297

Please sign in to comment.