-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
24 changed files
with
510 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # v0.1.0 | ||
| ## {{ "now"|date("m/d/Y") }} | ||
|
|
||
| 1. [](#new) | ||
| * ChangeLog started... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| The MIT License (MIT) | ||
|
|
||
| Copyright (c) {{ "now"|date("Y") }} {{ component.author.name }} | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| {% set component_title = (component.name|titleize) %} | ||
| {% set component_hyphenated = (component.name|hyphenize) %} | ||
| {% set developer_hyphenated = (component.author.githubid|hyphenize) %} | ||
| # {{ component_title }} Plugin | ||
|
|
||
| **This README.md file should be modified to describe the features, installation, configuration, and general usage of the plugin.** | ||
|
|
||
| The **{{ component_title }}** Plugin is an extension for [Grav CMS](https://github.com/getgrav/grav). {{ component.description }} | ||
|
|
||
| ## Installation | ||
|
|
||
| Installing the {{ component_title }} plugin can be done in one of three ways: The GPM (Grav Package Manager) installation method lets you quickly install the plugin with a simple terminal command, the manual method lets you do so via a zip file, and the admin method lets you do so via the Admin Plugin. | ||
|
|
||
| ### GPM Installation (Preferred) | ||
|
|
||
| To install the plugin via the [GPM](https://learn.getgrav.org/cli-console/grav-cli-gpm), through your system's terminal (also called the command line), navigate to the root of your Grav-installation, and enter: | ||
|
|
||
| bin/gpm install {{ component_hyphenated }} | ||
|
|
||
| This will install the {{ component_title }} plugin into your `/user/plugins`-directory within Grav. Its files can be found under `/your/site/grav/user/plugins/{{ component_hyphenated }}`. | ||
|
|
||
| ### Manual Installation | ||
|
|
||
| To install the plugin manually, download the zip-version of this repository and unzip it under `/your/site/grav/user/plugins`. Then rename the folder to `{{ component_hyphenated }}`. You can find these files on [GitHub](https://github.com/{{ developer_hyphenated }}/grav-plugin-{{ component_hyphenated }}) or via [GetGrav.org](https://getgrav.org/downloads/plugins). | ||
|
|
||
| You should now have all the plugin files under | ||
|
|
||
| /your/site/grav/user/plugins/{{ component_hyphenated }} | ||
|
|
||
| > NOTE: This plugin is a modular component for Grav which may require other plugins to operate, please see its [blueprints.yaml-file on GitHub](https://github.com/{{ developer_hyphenated }}/grav-plugin-{{ component_hyphenated }}/blob/main/blueprints.yaml). | ||
|
|
||
| ### Admin Plugin | ||
|
|
||
| If you use the Admin Plugin, you can install the plugin directly by browsing the `Plugins`-menu and clicking on the `Add` button. | ||
|
|
||
| ## Configuration | ||
|
|
||
| Before configuring this plugin, you should copy the `user/plugins/{{ component_hyphenated }}/{{ component_hyphenated }}.yaml` to `user/config/plugins/{{ component_hyphenated }}.yaml` and only edit that copy. | ||
|
|
||
| Here is the default configuration and an explanation of available options: | ||
|
|
||
| ```yaml | ||
| enabled: true | ||
| ``` | ||
|
|
||
| Note that if you use the Admin Plugin, a file with your configuration named {{component_hyphenated}}.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 | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| {% set githubid = component.author.githubid ?: component.author.name|hyphenize -%} | ||
| name: {{ component.name|titleize }} | ||
| slug: {{ component.name|hyphenize }} | ||
| type: plugin | ||
| version: 0.1.0 | ||
| description: {{ component.description }} | ||
| icon: plug | ||
| author: | ||
| name: {{ component.author.name }} | ||
| email: {{ component.author.email }} | ||
| homepage: https://github.com/{{ githubid }}/grav-plugin-{{ component.name|hyphenize }} | ||
| demo: http://demo.yoursite.com | ||
| keywords: grav, plugin, etc | ||
| bugs: https://github.com/{{ githubid }}/grav-plugin-{{ component.name|hyphenize }}/issues | ||
| docs: https://github.com/{{ githubid }}/grav-plugin-{{ component.name|hyphenize }}/blob/develop/README.md | ||
| license: MIT | ||
|
|
||
| dependencies: | ||
| - { name: grav, version: '>=1.6.0' } | ||
|
|
||
| form: | ||
| validation: loose | ||
| fields: | ||
| enabled: | ||
| type: toggle | ||
| label: PLUGIN_ADMIN.PLUGIN_STATUS | ||
| highlight: 1 | ||
| default: 0 | ||
| options: | ||
| 1: PLUGIN_ADMIN.ENABLED | ||
| 0: PLUGIN_ADMIN.DISABLED | ||
| validate: | ||
| type: bool | ||
| text_var: | ||
| type: text | ||
| label: PLUGIN_{{ component.name|underscorize|upper }}.TEXT_VARIABLE | ||
| help: PLUGIN_{{ component.name|underscorize|upper }}.TEXT_VARIABLE_HELP |
Oops, something went wrong.