Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
FIX: Readme β€” Lingo Grammar πŸ’―
  • Loading branch information
Ahmad Awais committed Jul 15, 2017
1 parent 9562aac commit b770e23
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 12 deletions.
5 changes: 2 additions & 3 deletions README.md
Expand Up @@ -21,15 +21,14 @@
![gutenberg-boilerpalte](https://i.imgur.com/P5rw2pS.jpg)
WordPress Gutenberg Boilerplate! A boilerplate to build WP Gutenberg blocks and stuff! ✊


## ⚑️ Getting Started

Just [download](https://github.com/ahmadawais/Gutenberg-Boilerplate/archive/master.zip) and install this plugin in your WordPress website and read the source code!
Install the [Gutenberg](https://wordpress.org/plugins/gutenberg/) WordPress plugin and then download and install [Gutenberg Boilerplate Zip](https://github.com/ahmadawais/Gutenberg-Boilerplate/archive/master.zip). Now read the source code! πŸ’―

## ⚑️ What Can You Learn?

This is a `todo` list for this boilerplate which also states the progress of what you can learn from it.
- [X] [Build a Custom Gutenberg Block](https://github.com/ahmadawais/Gutenberg-Boilerplate/tree/master/block/01-basic) β€” with custom CSS for editor and frontend.
- [X] [Build a Custom Gutenberg Block](https://github.com/ahmadawais/Gutenberg-Boilerplate/tree/master/block/01-basic) β€” with custom CSS for editor and front end.
- [x] [Build a Custom Gutenberg Block](https://github.com/ahmadawais/Gutenberg-Boilerplate/tree/master/block/02-basic-esnext) β€” with `ES6` or `ESNext` and a `Webpack` build process.
- [x] [Build a Custom Gutenberg Block](https://github.com/ahmadawais/Gutenberg-Boilerplate/tree/master/block/03-block-editable) β€” with `editable` content.
- [x] [Build a Custom Gutenberg Block](https://github.com/ahmadawais/Gutenberg-Boilerplate/tree/master/block/04-tweet) β€” to click Tweet the contents of that block.
Expand Down
4 changes: 2 additions & 2 deletions block/01-basic/README.md
Expand Up @@ -4,6 +4,6 @@ This is a basic custom Gutenberg block. Files explained below.

- [`block.js`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/01-basic/block.js) β€” We register Custom Gutenberg block here.
- [`editor.css`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/01-basic/editor.css) _ Block CSS for the editor.
- [`style.css`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/01-basic/style.css) β€” Block CSS for the frontend.
- [`index.php`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/01-basic/index.php) β€” Enqueue block's assets for editor and the frontend.
- [`style.css`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/01-basic/style.css) β€” Block CSS for the front end.
- [`index.php`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/01-basic/index.php) β€” Enqueue block's assets for editor and the front end.

6 changes: 3 additions & 3 deletions block/02-basic-esnext/README.md
Expand Up @@ -5,15 +5,15 @@ This is a basic custom Gutenberg block. Files explained below.
- [`block.js`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/02-basic-esnext/block.js) β€” We register Custom Gutenberg block here.
- [`block.build.js`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/02-basic-esnext/block.build.js) β€” Built file from `block.js` via NPM Script and Webpack.
- [`editor.css`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/02-basic-esnext/editor.css) _ Block CSS for the editor.
- [`style.css`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/02-basic-esnext/style.css) β€” Block CSS for the frontend.
- [`index.php`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/02-basic-esnext/index.php) β€” Enqueue block's assets for editor and the frontend.
- [`style.css`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/02-basic-esnext/style.css) β€” Block CSS for the front end.
- [`index.php`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/02-basic-esnext/index.php) β€” Enqueue block's assets for the editor and the front end.
- [`.babelrc`](./.babelrc) β€” Babel custom configuration.
- [`.gitignore`](./.gitignore) β€” Git ignore file to ignore node_modules and such other files.
- [`package.json`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/02-basic-esnext/package.json) & [`package-lock.json`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/02-basic-esnext/package-lock.json) β€” NPM related file for holding NPM related metadata and `build`/`dev` NPM scripts.
- [`webpack.config.js`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/02-basic-esnext/webpack.config.js) β€” Webpack configuration file.


## Getting started!
## Getting Started!

Read the files explained above. All of the files are heavily inline documented. All you have to do is following:

Expand Down
4 changes: 2 additions & 2 deletions block/03-block-editable/README.md
Expand Up @@ -4,5 +4,5 @@ This is a basic custom editable Gutenberg block. Files explained below.

- [`block.js`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/03-block-editable/block.js) β€” We register Custom Gutenberg block here.
- [`editor.css`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/03-block-editable/editor.css) _ Block CSS for the editor.
- [`style.css`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/03-block-editable/style.css) β€” Block CSS for the frontend.
- [`index.php`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/03-block-editable/index.php) β€” Enqueue block's assets for editor and the frontend.
- [`style.css`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/03-block-editable/style.css) β€” Block CSS for the front end.
- [`index.php`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/03-block-editable/index.php) β€” Enqueue block's assets for the editor and the front end.
4 changes: 2 additions & 2 deletions block/04-tweet/README.md
Expand Up @@ -4,5 +4,5 @@ This is a basic custom Tweet Block for Gutenberg. Files explained below.

- [`block.js`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/04-tweet/block.js) β€” We register Custom Gutenberg block here.
- [`editor.css`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/04-tweet/editor.css) _ Block CSS for the editor.
- [`style.css`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/04-tweet/style.css) β€” Block CSS for the frontend.
- [`index.php`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/04-tweet/index.php) β€” Enqueue block's assets for editor and the frontend.
- [`style.css`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/04-tweet/style.css) β€” Block CSS for the front end.
- [`index.php`](https://github.com/ahmadawais/Gutenberg-Boilerplate/blob/master/block/04-tweet/index.php) β€” Enqueue block's assets for the editor and the front end.

0 comments on commit b770e23

Please sign in to comment.