Skip to content

Commit

Permalink
Document minimum content
Browse files Browse the repository at this point in the history
This will be true shortly after some editor tweaks.
  • Loading branch information
microbit-matt-hillsdon committed Mar 26, 2024
1 parent c365742 commit e915d7f
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ export default defineConfig({
// ...
plugins: [structureTool({structure}), pythonEditor()],
schema: {
types: yourSchemaTypes,
// All necessary types are provided by the plugin.
types: [],
},
})
```
Expand All @@ -43,6 +44,15 @@ Using the exported structure is optional.
If you need to augment the types defined in this plugin then you can transform them in
your app by providing a [function as the types field](https://www.sanity.io/docs/schema-types).

The Python Editor expects some minimum content:

- A document of type `pythonIdeasConfig` with the ID `pythonIdeasConfig` and language "en".
If you use the suggested desk structure you can just publish the document under Ideas > Config.
- A document of type `toolkit` with the name "Reference" and language "en".

You'll want to add additional content otherwise the tabs will be blank but this is the minimum
needed to avoid errors.

## Develop & test

This plugin uses [@sanity/plugin-kit](https://github.com/sanity-io/plugin-kit)
Expand Down

0 comments on commit e915d7f

Please sign in to comment.