Skip to content

Commit

Permalink
docs: adding root README.md (#3)
Browse files Browse the repository at this point in the history
  • Loading branch information
BibiSebi committed Sep 20, 2023
1 parent 19a9d34 commit 72d90c5
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,16 @@
# space-tool-plugins
# Storyblok Space/Tool Plugins
This repository is a collection of starters to help developers quickly start building their own Storyblok plugins.

> **Warning:** This repository is still considered as work in progress. While the team is actively developing and curating content to support your needs, it may not be in its final, polished state.
## Introduction
Inside each project you will find a detailed README.md file that will provide instructions on how to clone and run the code. Here is a short list of all projects inside of this repository:

- [Story starter](story-starter/README.md)
- [Tool Next.js Starter](tool-nextjs-starter/README.md)

## Glossary

- `Space Plugins`(also known as [Custom Sidebar Applications](https://www.storyblok.com/docs/plugins/custom-application)) are plugins that are present only once inside a space or organisation. Common Use-Cases for this kind of plugins are bulk operations on the content. One example of a Space Plugin is the [Broken Links Checker](https://www.storyblok.com/apps/storyblok-gmbh@broken-links-checker)

- `Tool Plugins` (also known as [Tools](https://www.storyblok.com/docs/plugins/tool)) are plugins that can be found within every story inside the tool section. These plugins usually provide operations on the story level. An example would be the [Export Translatable Fields Tool](https://www.storyblok.com/apps/export), which lets the user export all translatable fields of a story to either a JSON or XML format.
Empty file added story-starter/README.md
Empty file.

0 comments on commit 72d90c5

Please sign in to comment.