Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/automattic/create-content-model
Create content models from the UI
https://github.com/automattic/create-content-model
wordpress
Last synced: about 1 month ago
JSON representation
Create content models from the UI
- Host: GitHub
- URL: https://github.com/automattic/create-content-model
- Owner: Automattic
- License: gpl-2.0
- Created: 2024-08-07T20:38:35.000Z (3 months ago)
- Default Branch: trunk
- Last Pushed: 2024-09-12T14:21:23.000Z (2 months ago)
- Last Synced: 2024-10-07T11:16:24.093Z (about 1 month ago)
- Topics: wordpress
- Language: PHP
- Homepage:
- Size: 669 KB
- Stars: 124
- Watchers: 14
- Forks: 5
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Create Content Model
_Define custom post types & fields in the Block Editor._
WordPress.com’s experimental Create Content Model plugin transforms the way custom post types and custom fields are created and managed in WordPress by making use of the latest core features to bring content modeling into the Block Editor. Additionally, the created data model and data entry UI can be exported as a standalone, maintenance-free plugin.
[](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/Automattic/create-content-model/trunk/blueprint.json)
You can also test out the plugin locally with [Studio](https://developer.wordpress.com/studio/?utm_source=github&utm_medium=readme&utm_campaign=create-content-model)! Check out the [Get Started](/get-started.md#test-locally-with-studio) guide for details.
https://github.com/user-attachments/assets/723a973a-eb92-4b71-9f64-ac269d0f9861
For a more thorough introduction, check out Brian Coord's [Custom fields and post types inside the block editor livestream](https://www.youtube.com/watch?v=VLB3OkgNOTs).
## Getting Started
Find detailed instructions on creating your content model using this plugin in the [Get Started](/get-started.md) guide.
[](https://github.com/Automattic/create-content-model/releases/latest/download/create-content-model.zip)
## About
Our team at WordPress.com is excited to share our recent prototyping efforts on game changing approaches to custom content creation.
The Create Content Model plugin builds upon our custom post types project at the [CloudFest Hackathon in 2024](https://wordpress.com/blog/2024/04/15/custom-post-types-wordpress-admin/?utm_source=github&utm_medium=readme&utm_campaign=create-content-model). We’ve leveraged core functionality, like [block bindings](https://make.wordpress.org/core/2024/03/06/new-feature-the-block-bindings-api/) and [block variations](https://developer.wordpress.org/block-editor/reference-guides/block-api/block-variations/), to create a new paradigm for creating and managing custom post types and custom fields in WordPress.
Unlike existing custom post type and custom field plugins, our plugin takes a native approach by putting the creation and management of these elements directly in the WordPress Block Editor. Using the Block Bindings API, `post_meta` fields are bound to block attributes. Block variations are created from each bound block for use in front-end template layouts. The result is an extremely intuitive workflow for both the setup of custom post types and fields and their usage in front-end templating.
A key feature of the Create Content Model plugin is the export of a locked custom data model and a data entry UI. Developers can generate and reuse the same content models on multiple sites without ongoing plugin maintenance or costs. They can hand off fully functional sites with locked custom post types and fields, ready for clients to populate the content.
## Development
* Run `npm install` to install the dependencies
* Run `npm run dev-server` to start the local WordPress server
* In a new terminal window, run `npm start` to start the JavaScript bundler watcher
### Bundling
Run `npm run plugin-zip` to create a zip file of the plugin. This will automatically bundle the JavaScript files.
### Creating a new release
Create a new release by filling the form on [this page](https://github.com/Automattic/create-content-model/releases/new).
The release title and tag ("Choose a tag" selectbox, above the title) should be in the Semver format (`major.minor.patch`).
The release description should be a list of bullet points of the most meaningful changes. You can copy the commit title from the merged PRs.
After clicking "Publish release," a [GitHub workflow](https://github.com/Automattic/create-content-model/blob/trunk/.github/workflows/release.yml) will bundle the plugin and export the release artifact.
## Contribute & Contact
Want to help us move this concept forward?
Feel free to open an issue in the repo to discuss your proposed improvement. Pull requests are welcome for bug fixes and enhancements.
We built this as a prototype and may invest into it further based on level of interest. Our near term vision is outlined in this [roadmap issue](https://github.com/Automattic/create-content-model/issues/77).
## Licensing
[GNU General Public License](/LICENSE.md)
## Credits & Acknowledgements
We’d like to thank the team at WordPress.com who made this project possible: [Luis Felipe Zaguini](https://github.com/zaguiini), [Candy Tsai](https://github.com/candy02058912), [Autumn Fjeld](https://github.com/autumnfjeld), [Brian Coords](https://github.com/bacoords), [Daniel Bachhuber](https://github.com/danielbachhuber).
## Stay in the Loop with WordPress.com
Follow us:
[](https://www.linkedin.com/showcase/wordpress.com)
[](https://x.com/wordpressdotcom)
[](https://www.instagram.com/wordpressdotcom)
And while you’re at it, check out our [WordPress hosting solution for developers](https://wordpress.com/hosting?utm_source=github&utm_medium=readme&utm_campaign=create-content-model) and [our agency program](https://wordpress.com/for-agencies/?utm_source=github&utm_medium=readme&utm_campaign=create-content-model).