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.
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
Reorganise documentation #11817
Merged
Merged
Reorganise documentation #11817
Changes from all commits
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
fdf1591
Initial reworking; props @0aveRyan
chrisvanpatten 01476c9
Fixes for the manifest/generators
chrisvanpatten 44af175
A few missed items and small formatting tweaks
chrisvanpatten f0b5933
Simplify/flatten the directory structure
chrisvanpatten 7631868
Cheat my way around a merge conflict pt1
chrisvanpatten 19c45fe
fight the git powers
chrisvanpatten 4b971ad
JSON version of TOC instead of YML
chrisvanpatten f059f9d
Ensure all files have good titles
chrisvanpatten 982a1c0
Add a generator script and re-generate the root-manifest
chrisvanpatten 2b9b6be
Update docs/designers-developers/designers/block-design.md
0899e99
Update docs/designers-developers/key-concepts.md
mcsf 521e71b
Get a handful of internal link references fixed
chrisvanpatten 90887df
Merge branch 'big/reorganise-docs' of github.com:WordPress/gutenberg …
chrisvanpatten 228417f
Another batch of internal links
chrisvanpatten e6492a3
Update docs/tool/manifest.js
mcsf 8838f71
Additional broken internal link fixes
chrisvanpatten 9137200
Merge branch 'big/reorganise-docs' of github.com:WordPress/gutenberg …
chrisvanpatten f56e67e
A few more links
chrisvanpatten d7a1026
Revert use of lt/gt symbols in link
chrisvanpatten 0912c33
Fix more broken internal links
chrisvanpatten a0a6349
Remove docs generator
chrisvanpatten f3b7273
Broken manifest.json
chrisvanpatten File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Designer Documentation | ||
|
||
For those designing blocks and other Block Editor integrations, this documentation will provide resources for creating beautiful and intuitive layouts. |
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Developer Documentation | ||
|
||
Gutenberg is highly flexible, like most of WordPress. You can build custom blocks, modify the editor's appearance, add special plugins, and much more. | ||
|
||
## Creating Blocks | ||
|
||
Gutenberg is about blocks, and the main extensibility API of Gutenberg is the Block API. It allows you to create your own static blocks, dynamic blocks rendered on the server and also blocks capable of saving data to Post Meta for more structured content. | ||
|
||
If you want to learn more about block creation, the [Blocks Tutorial](../../../docs/designers-developers/developers/tutorials/block-tutorial/intro.md) is the best place to start. | ||
|
||
## Extending Blocks | ||
|
||
It is also possible to modify the behavior of existing blocks or even remove them completely using filters. | ||
|
||
Learn more in the [Block Filters](../../../docs/designers-developers/developers/reference/hooks/block-filters.md) section. | ||
|
||
## Extending the Editor UI | ||
|
||
Extending the editor UI can be accomplished with the `registerPlugin` API, allowing you to define all your plugin's UI elements in one place. | ||
|
||
Refer to the [Plugins](https://github.com/WordPress/gutenberg/blob/master/packages/plugins/README.md) and [Edit Post](https://github.com/WordPress/gutenberg/blob/master/packages/edit-post/README.md) section for more information. | ||
|
||
You can also filter certain aspects of the editor; this is documented on the [Editor Filters](../../../docs/designers-developers/developers/reference/hooks/editor-filters.md) page. | ||
|
||
## Meta Boxes | ||
|
||
**Porting PHP meta boxes to blocks and Gutenberg plugins is highly encouraged!** | ||
|
||
Discover how [Meta Box](../../../docs/designers-developers/developers/backwards-compatibility/meta-box.md) support works in Gutenberg. | ||
|
||
## Theme Support | ||
|
||
By default, blocks provide their styles to enable basic support for blocks in themes without any change. Themes can add/override these styles, or rely on defaults. | ||
|
||
There are some advanced block features which require opt-in support in the theme. See [theme support](../../../docs/designers-developers/developers/themes/theme-support.md). | ||
|
||
## Autocomplete | ||
|
||
Autocompleters within blocks may be extended and overridden. Learn more about the [autocomplete](../../../docs/designers-developers/developers/filters/autocomplete-filters.md) filters. | ||
|
||
## Block Parsing and Serialization | ||
|
||
Posts in the editor move through a couple of different stages between being stored in `post_content` and appearing in the editor. Since the blocks themselves are data structures that live in memory it takes a parsing and serialization step to transform out from and into the stored format in the database. | ||
|
||
Customizing the parser is an advanced topic that you can learn more about in the [Extending the Parser](../../../docs/designers-developers/developers/filters/parser-filters.md) section. |
1 change: 1 addition & 0 deletions
1
docs/designers-developers/developers/backwards-compatibility/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Backwards Compatibility |
2 changes: 2 additions & 0 deletions
2
docs/reference/deprecated.md → ...s/backwards-compatibility/deprecations.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Block API Reference | ||
|
||
Blocks are the fundamental element of the Gutenberg editor. They are the primary way in which plugins and themes can register their own functionality and extend the capabilities of the editor. | ||
|
||
## Registering a block | ||
|
||
All blocks must be registered before they can be used in the editor. You can learn about block registration, and the available options, in the [block registration](block-api/block-registration.md) documentation. | ||
|
||
## Block `edit` and `save` | ||
|
||
The `edit` and `save` functions define the editor interface with which a user would interact, and the markup to be serialized back when a post is saved. They are the heart of how a block operates, so they are [covered separately](block-api/block-edit-save.md). |
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Data Module Reference | ||
|
||
- [**core**: WordPress Core Data](../../docs/designers-developers/developers/data/data-core.md) | ||
- [**core/annotations**: Annotations](../../docs/designers-developers/developers/data/data-core-annotations.md) | ||
- [**core/blocks**: Block Types Data](../../docs/designers-developers/developers/data/data-core-blocks.md) | ||
- [**core/editor**: The Editor’s Data](../../docs/designers-developers/developers/data/data-core-editor.md) | ||
- [**core/edit-post**: The Editor’s UI Data](../../docs/designers-developers/developers/data/data-core-edit-post.md) | ||
- [**core/notices**: Notices Data](../../docs/designers-developers/developers/data/data-core-notices.md) | ||
- [**core/nux**: The NUX (New User Experience) Data](../../docs/designers-developers/developers/data/data-core-nux.md) | ||
- [**core/viewport**: The Viewport Data](../../docs/designers-developers/developers/data/data-core-viewport.md) |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Filter Reference | ||
|
||
[Hooks](https://developer.wordpress.org/plugins/hooks/) are a way for one piece of code to interact/modify another piece of code. They provide one way for plugins and themes interact with Gutenberg, but they’re also used extensively by WordPress Core itself. | ||
|
||
There are two types of hooks: [Actions](https://developer.wordpress.org/plugins/hooks/actions/) and [Filters](https://developer.wordpress.org/plugins/hooks/filters/). In addition to PHP actions and filters, Gutenberg also provides a mechanism for registering and executing hooks in JavaScript. This functionality is also available on npm as the [@wordpress/hooks](https://www.npmjs.com/package/@wordpress/hooks) package, for general purpose use. | ||
|
||
You can also learn more about both APIs: [PHP](https://codex.wordpress.org/Plugin_API/) and [JavaScript](https://github.com/WordPress/packages/tree/master/packages/hooks). |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just an observation that these are absolute links.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not happy with the way we're handling static assets right now but for now I would just leave it alone. Long term it would be nice to not even commit static assets to this repo.