https://github.com/front/g-editor
A minimalist version of the Gutenberg editor
https://github.com/front/g-editor
Last synced: 4 months ago
JSON representation
A minimalist version of the Gutenberg editor
- Host: GitHub
- URL: https://github.com/front/g-editor
- Owner: front
- License: mit
- Created: 2018-10-17T13:36:47.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-28T04:37:04.000Z (almost 2 years ago)
- Last Synced: 2025-08-20T17:39:39.829Z (10 months ago)
- Language: JavaScript
- Homepage:
- Size: 12.4 MB
- Stars: 191
- Watchers: 25
- Forks: 39
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# g-editor
A minimalist version of Gutenberg's editor. Ideal for checking your custom blocks.
``` bash
npm install @frontkom/g-editor
npm start
```
You can include your custom block by passing its path in `BLOCK_DIR` env var.
``` bash
BLOCK_DIR=\absolute\path\to\your-custom-block npm start
```
The editor expects that your custom block has an `index.js` and a `style.css` in its `build` folder.
```
your-custom-block
├── ...
├── build
│ ├── index.js
│ └── style.css
└── ...
```
## g-editor and Gutenberg-js
Since version 1.0, `g-editor` no longer depends on `Gutenberg-js`.
It now includes the source `Gutenberg` packages directly.
## Current Gutenberg version
[v8.5.1](https://github.com/WordPress/gutenberg/releases/tag/v8.5.1)
### Better updates
To update Gutenberg packages, run
```
npm run g-update
```
It will pull to your local machine from the WordPress repo the Gutenberg packages assets ready to use. After copy those assets to `public/vendor/gutenberg`, the script will generate `g-scripts.txt` and `g-styles.txt` files with all the depencies the editor needs to run.
## Assets
The sample videos are a courtesy of [Pixabay](https://pixabay.com/):
* [https://pixabay.com/en/videos/cute-cat-funny-cat-kitten-domestic-3092/](https://pixabay.com/en/videos/cute-cat-funny-cat-kitten-domestic-3092/)
* [https://pixabay.com/en/videos/cat-cat-thailand-small-indian-civet-1297/](https://pixabay.com/en/videos/cat-cat-thailand-small-indian-civet-1297/)