Skip to content

Latest commit

 

History

History
56 lines (29 loc) · 2.68 KB

README.md

File metadata and controls

56 lines (29 loc) · 2.68 KB
Raw

Grav Markdown Generator Plugin

This README.md file should be modified to describe the features, installation, configuration, and general usage of this plugin.

The Grav Markdown Generator Plugin is for Grav CMS. Generates a new markdown file using the Lorem Markdownum generator from https://jaspervdj.be/lorem-markdownum/.

Installation

Installing the Grav Markdown Generator plugin can be done in one of two ways. The 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.

GPM Installation (Preferred)

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 grav-markdown-generator

This will install the Grav Markdown Generator plugin into your /user/plugins directory within Grav. Its files can be found under /your/site/grav/user/plugins/grav-markdown-generator.

Manual Installation

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 grav-markdown-generator. You can find these files on GitHub or via GetGrav.org.

You should now have all the plugin files under

/your/site/grav/user/plugins/grav-markdown-generator

NOTE: This plugin is a modular component for Grav which requires Grav and the Error and Problems to operate.

Admin Plugin

If you use the admin plugin, you can install directly through the admin plugin by browsing the Plugins tab and clicking on the Add button.

Configuration

Before configuring this plugin, you should copy the user/plugins/grav-markdown-generator/grav-markdown-generator.yaml to user/config/plugins/grav-markdown-generator.yaml and only edit that copy.

Here is the default configuration and an explanation of available options:

enabled: true

Note that if you use the admin plugin, a file with your configuration, and named grav-markdown-generator.yaml will be saved in the user/config/plugins/ folder once the configuration is saved in the admin.

Usage

Describe how to use the plugin.

Credits

Did you incorporate third-party code? Want to thank somebody?

To Do

  • Future plans, if any