Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation: Add a page about the format library to the platform docs site #55037

Merged
merged 2 commits into from
Oct 4, 2023
Merged

Documentation: Add a page about the format library to the platform docs site #55037

merged 2 commits into from
Oct 4, 2023

Conversation

youknowriad
Copy link
Contributor

@youknowriad youknowriad commented Oct 4, 2023 •
edited
Loading

Related #53874

What?

This PR add a small documentation page about the format library package and how to leverage it in third-party block editors.
It's also weird that the "block library" package exports a function to register the blocks while the format library auto-registers the formats as soon as you import it. It might be good to unify at some point. cc @ellatrix

Note I have personally tested all the code examples in a third-party vite install.

Test the documentation website

cd platform-docs
npm install
npm start

@youknowriad youknowriad added the [Type] Developer Documentation Documentation for developers label Oct 4, 2023
@youknowriad youknowriad requested a review from a team October 4, 2023 09:38
@youknowriad youknowriad self-assigned this Oct 4, 2023
@youknowriad youknowriad requested review from getdave, aristath, ellatrix, ntsekouras and t-hamano and removed request for a team October 4, 2023 09:38
tyxla
tyxla approved these changes Oct 4, 2023
View reviewed changes
Copy link
Member

@tyxla tyxla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great to me 👍 Thanks 🚀

@youknowriad @tyxla
Fix typo
7592028 
Co-authored-by: Marin Atanasov <[email protected]>
@youknowriad youknowriad enabled auto-merge (squash) October 4, 2023 13:19
@youknowriad youknowriad merged commit 1be856b into trunk Oct 4, 2023
@youknowriad youknowriad deleted the docs/add-format-library-platform-docs branch October 4, 2023 14:05
@github-actions github-actions bot added this to the Gutenberg 16.8 milestone Oct 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tyxla tyxla tyxla approved these changes

@getdave getdave Awaiting requested review from getdave getdave was automatically assigned from WordPress/gutenberg-core

@aristath aristath Awaiting requested review from aristath aristath was automatically assigned from WordPress/gutenberg-core

@ellatrix ellatrix Awaiting requested review from ellatrix

@ntsekouras ntsekouras Awaiting requested review from ntsekouras

@t-hamano t-hamano Awaiting requested review from t-hamano

Assignees

@youknowriad youknowriad

Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Milestone
Gutenberg 16.8
Development

Successfully merging this pull request may close these issues.
2 participants
@youknowriad @tyxla