Glossary block for the Gutenberg editor.
This plugin provides a multilanguage glossary-block for the WordPress-Gutenberg-Editor. It also includes a backend to add, update and remove entries from within the glossary.
To install the plugin simply download it from the WordPress repository. After activation within your WordPress instance the plugin is ready to go.
Alternatively you can download the release from Github and activate the plugin with the plugin-upload function of your WordPress instance.
- The plugin actively supports multi-language sites and offers the following languages in both the frontend and the backend:
- English
- French
- German
- Italian
- The backend has filtering options to filter by letter and language.
- The colors of the frontend are completely adjustable.
- The frontend adjusts itself to fit the container size (responsive / mobile friendly).
We really appreciate the time and effort many developers invest into open source. We welcome anyone interested in contributing to this repository. However, when contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
The following software has to be installed in order for you to be able to adjust and build this plugin (newer versions should also work):
- Install npm dependencies
npm i
- Install composer dependencies
composer install
- Configure
phpcs
for use with WordPress guidelinesphpcs --config-set installed_paths <path to repository>/vendor/wp-coding-standards/wpcs
- Run
phpcs -i
which should return amongst other thingsWordPress, WordPress-Extra, WordPress-Docs and WordPress-Core
- Install the phpcs extension for vscode (optional)
- Install the eslint extension for vscode (optional)
- Use to compile and the block in development mode.
- Compiles the plugin into the
dist
folder. - Creates
glossary-by-arteeo.zip
which can be uploaded to a WordPress instance.
- Use to build the plugin in production mode
- Compiles the plugin into the
dist
folder. - Creates
glossary-by-arteeo.zip
which can be uploaded to a WordPress instance.
- Checks if the css/scss files are in accordance with the WordPress guidelines.
- Checks if the js files are in accordance with the WordPress guidelines.
- Checks if the md files inside the root directory are in accordance with the WordPress guidelines.
- Checks if the js code-parts inside md files are in accordance with the WordPress guidelines.
- Checks if the package.json is in accordance with the WordPress guidelines.
- Updates the WordPress packages used in the project to their latest version.
WordPress-Scripts is a dependency, therefore all scripts described here are theoretically available.