string-replacer is a Grav plugin that allows the substitution of a string contained into a post or a page. This is a useful plugin that you can use to add pure HTML, CSS, JS, and any raw content into a post, using a shortcode, or a previously defined string, based on your preferences.
Installing the String Replacer plugin can be done in one of two ways. Our GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.
The simplest way to install this plugin is via the Grav Package Manager (GPM) through your system's Terminal (also called the command line). From the root of your Grav install type:
bin/gpm install string-replacer
This will install the String Replacer plugin into your /user/plugins directory within Grav. Its files can be found under /your/site/grav/user/plugins/string-replacer.
To install this plugin, just download the zip version of this repository and unzip it under /your/site/grav/user/plugins. Then, rename the folder to string-replacer. You can find these files either on GitHub or via GetGrav.org.
You should now have all the plugin files under
/your/site/grav/user/plugins/string-replacer
As development for the String Replacer plugin continues, new versions may become available that add additional features and functionality, improve compatibility with newer Grav releases, and generally provide a better user experience. Updating String Replacer is easy, and can be done through Grav's GPM system, as well as manually.
The simplest way to update this plugin is via the Grav Package Manager (GPM). You can do this with this by navigating to the root directory of your Grav install using your system's Terminal (also called command line) and typing the following:
bin/gpm update string-replacer
This command will check your Grav install to see if your String Replacer plugin is due for an update. If a newer release is found, you will be asked whether or not you wish to update. To continue, type y and hit enter. The theme will automatically update and clear Grav's cache.
Manually updating String Replacer is pretty simple. Here is what you will need to do to get this done:
- Delete the
your/site/user/plugins/string-replacerdirectory. - Download the new version of the String Replacer plugin from either GitHub or GetGrav.org.
- Unzip the zip file in
your/site/user/pluginsand rename the resulting folder tostring-replacer. - Clear the Grav cache. The simplest way to do this is by going to the root Grav directory in terminal and typing
bin/grav clear-cache.
Note: Any changes you have made to any of the files listed under this directory will also be removed and replaced by the new set. Any files located elsewhere (for example a YAML settings file placed in
user/config/plugins) will remain intact.
enabled: true
Once the plugin is installed you can use the admin panel to add:
- one or more strings to find into the content of the posts or pages;
- the equivalent strings to use for substitution (containing plain text, HTML, CSS, JS code, and so on...).