lopesmcc / tool-examples

A collection of tools to use with Storyblok by the community

Tool Examples

A collection of tools & scripts for Storyblok created by the community.

Table of Content

• Examples
• Example Repositories
• Contributing

Examples

Each example contains a README.md with an explanation about the tool.

Example	Author
Clean Up Field Script A tool to remove a specific field from all stories	Alexander Feiglstorfer
Clone Assets A tool to clone assets from a space to its clone	Christian Zoppi
Storyblok Assets Backup Tool for differential backups of the assets of any Storyblok space	Christian Zoppi, Gerrit Plehn
Private assets demo A demo to showcase how to use private assets as gated content	Edoardo Sandon

Example Repositories

The following examples live in their own Github repository.

Example	Author
React Rich Text Renderer For Storyblok In Built Rte Renderer to outputs React elements, and provides options to map any Stoyblok rich text element to custom React components	dohomi
Storyblok Generate Component Typings NodeJS tool to auto generate TypeScript types based on your components.x.json file	dohomi
Storyblok Migrate Migration tool from Storyblok (Import/Export of schemas and content)	maoberlehner
Sb Mig CLI tool to handle migrations and components in Storyblok	sb-mig

Contributing

Have an example? Submit a PR or open an issue.We are happy to accept more examples from the community.

Adding an example in this repository

1. Create a new folder for your tool

2. Add a README.md file in your example folder with a markdown table of the following format:

Name	Description	Author
Name of your tool	Short description	Your Github

3. Make sure your contribution matches the linting setup for this repo:

Run the linting via

npm run lint

4. Regenerate the README.md with the following command

npm run docs

5. Open a new pull request with your example. ⚡️

Adding an example in a different repository

If you want to be listed in the Example Repositories, follow these steps:

1. Create a new entry with a name, description, and githubUrl in the community-examples.json file.

2. Regenerate the README.md with the following command

npm run docs

3. Open a new pull request with your example.