https://github.com/etd-framework/grav-plugin-etdcontact
Manages contact information
https://github.com/etd-framework/grav-plugin-etdcontact
Last synced: about 1 month ago
JSON representation
Manages contact information
- Host: GitHub
- URL: https://github.com/etd-framework/grav-plugin-etdcontact
- Owner: etd-framework
- License: mit
- Created: 2018-06-06T09:34:47.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-06T11:37:23.000Z (about 8 years ago)
- Last Synced: 2025-03-03T23:59:36.523Z (over 1 year ago)
- Language: PHP
- Size: 2.93 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Etd Contact Plugin
**This README.md file should be modified to describe the features, installation, configuration, and general usage of this plugin.**
The **Etd Contact** Plugin is for [Grav CMS](http://github.com/getgrav/grav). Manages contact information.
## Installation
Installing the Etd Contact 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)](http://learn.getgrav.org/advanced/grav-gpm) through your system's terminal (also called the command line). From the root of your Grav install type:
bin/gpm install etdcontact
This will install the Etd Contact plugin into your `/user/plugins` directory within Grav. Its files can be found under `/your/site/grav/user/plugins/etdcontact`.
### 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 `etdcontact`. You can find these files on [GitHub](https://github.com/etd-solutions/grav-plugin-etdcontact) or via [GetGrav.org](http://getgrav.org/downloads/plugins#extras).
You should now have all the plugin files under
/your/site/grav/user/plugins/etdcontact
> NOTE: This plugin is a modular component for Grav which requires [Grav](http://github.com/getgrav/grav) and the [Error](https://github.com/getgrav/grav-plugin-error) and [Problems](https://github.com/getgrav/grav-plugin-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/etdcontact/etdcontact.yaml` to `user/config/plugins/etdcontact.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, and named etdcontact.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