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.

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

Create "Hello World" Block plugin examples with documentation #1619

Closed
ahmadawais opened this issue Jun 30, 2017 · 6 comments
Closed

Create "Hello World" Block plugin examples with documentation #1619

ahmadawais opened this issue Jun 30, 2017 · 6 comments
Labels
[Type] Developer Documentation Documentation for developers
Milestone

Comments

@ahmadawais
Copy link
Contributor

I have had been looking at the source code of Gutenberg lately and it seems that 3rd party Gutenberg blocks page is outdated.

I'd like to build a few 3rd party blocks to hunker down a few silly assumptions and for fun. Would it be possible for anyone to help collaborate in building a very simple boilerplate for creating 3rd Party Gutenberg blogs.

Ideally the boilerplate would have

  • Basic block setup
  • Documentation on edit and save methods
  • Basic documentation on how Gutenberg works (technical docs — much needed since React, JSX, ES6 etc. are pretty new for many WordPress developers)
  • Example blocks (take user input in edit and use it inside the saved state etc.)
  • NPM Scripts, Gulp, Webpack (basic configuration files for working with Babel, ES6, React, etc.)

Currently, working off an experimental plugin https://github.com/ahmadawais/Gutenberg-Blocks

Looking forward!

@ahmadawais ahmadawais changed the title [REQ/COLAB] Basic 3rd Party Block Boilerplate [REQ/COLLAB] Basic 3rd Party Block Boilerplate Jul 1, 2017
@ahmadawais
Copy link
Contributor Author

@georgestephanis I have created this separate ticket for what we discussed in #1184
Looking forward!

@jasmussen jasmussen added the [Type] Developer Documentation Documentation for developers label Jul 5, 2017
@jasmussen jasmussen changed the title [REQ/COLLAB] Basic 3rd Party Block Boilerplate Create "Hello World" Block plugin examples with documentation Jul 5, 2017
@jasmussen jasmussen added this to the Beta 0.4.0 milestone Jul 5, 2017
@jasmussen
Copy link
Contributor

Thank you for the ticket! I took the liberty of renaming it and putting it in a milestone!

@nylen
Copy link
Member

nylen commented Jul 5, 2017

As of #1717 this is possible to create in a reasonable way, and there is an extremely basic but usable implementation at https://github.com/nylen/gutenberg-examples.

We're also working on other components like a plugin with a Webpack ES6 build process and a documentation site that will replace the blocks/README.md. Once these are further along and we figure out how they should be structured, we'll move them under https://github.com/WordPress.

@ahmadawais
Copy link
Contributor Author

Thanks for that @jasmussen.
That's what I have had been trying to accomplish @nylen. Looking forward to it.

@mtias mtias modified the milestones: Beta 0.5.0, Beta 0.4.0 Jul 8, 2017
@antek83
Copy link

antek83 commented Jul 9, 2017

Hi guys, I would like to try to recreate, probably failing many times but who cares :), the most common shortcodes around: alerts, gmap, feature boxes etc.. as blocks for both exercise and public usage.

I cannot thank enough @nylen and @ahmadawais for the boilerplate and the demo twitter block examples.

I would like to ask where would be possible to find documentation regarding the available fields that can be used in the block's forms for example select boxes, radio buttons, color pickers etc?

@mtias
Copy link
Member

mtias commented Jul 11, 2017

Initial pass done in #1786.

@antekdesign the plan is to list such utilities in the docs at http://gutenberg-devdoc.surge.sh/. It will include modules from https://github.com/WordPress/gutenberg/tree/master/components and https://github.com/WordPress/gutenberg/tree/master/blocks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

No branches or pull requests

5 participants