Widget registry
How the community widget registry works, and how to submit your own widget to it.
The widgets shown on /search come from
awesome-grist-widgets,
a public, open-source list — anyone can add their widget to it.
Submitting a widget
- Add an entry to that repo's
widgets.jsonwith all four required fields:name,repoUrl(the canonical GitHub repository URL),widgetUrl(an install URL the target repo explicitly documents), anddescription. All four are required on every entry. - Run
npm run generate-readmeto regenerateREADME.mdfromwidgets.json— CI validates that the two stay in sync. - Open a pull request.
Using a coding agent? It can do this end-to-end — see that repo's
AGENTS.md
for the full process and rules. Most importantly: never invent a
widgetUrl — it has to be a URL the widget's own repo documents.
Requirements
Submissions must be public, open-source GitHub repositories with clear documentation, a license, installation instructions, and active maintenance.
Building a widget to submit
Nothing registry-specific — any widget built with grist-widget-sdk
qualifies once it meets the requirements above. Start with the
quickstart or the CLI reference, then
come back here when it's ready to list.