The specification for /.well-known/button.json
Find a file
2026-04-22 22:13:52 +02:00
.vscode Convert the 2026-03 file into the kramdown-rfc format 2026-03-28 23:34:44 +01:00
drafts Add guidance on using the Referer header to block hotlinking 2026-03-31 00:11:08 +02:00
.gitignore Convert the 2026-03 file into the kramdown-rfc format 2026-03-28 23:34:44 +01:00
current.md Adjust readme and links in various places 2026-03-29 00:23:51 +01:00
Justfile Convert the 2026-03 file into the kramdown-rfc format 2026-03-28 23:34:44 +01:00
README.md Adjust readme and links in various places 2026-03-29 00:23:51 +01:00

.well-known/button.json schema

This project aims to centralize the discussion and implementation of a file format for easily sharing 88x31 buttons available on websites.

The specification is being submitted to the IETF, for eventual publication as an Informational RFC. See the datatracker for more information. If possible, submit feedback as issues on this repository instead of the mailing list.

Please see the drafts folder for all drafts, and see here for the latest version.

Each draft version has a corresponding JSON schema available in the drafts folder.

Tools

The Hyperjump JSON Schema Verifier is useful to ensure the schema has no errors.

We use kramdown-rfc for converting Markdown to RFC v3 XML. The justfile contains a basic pipeline. You can also use the author tools.

Plans for the future

  • webapp for easily working with the format
  • implementation guide for clients
  • proper changelog

Credits

Full credits are also included in the Internet-Draft under Contributors and Acknowledgements.