grav-plugin-newsletter
所属分类:前端开发
开发工具:PHP
文件大小:0KB
下载次数:0
上传日期:2019-07-23 18:56:35
上 传 者:
sh-1993
说明: Grav CMS的新闻稿插件,
(Newsletter Plugin for Grav CMS,)
文件列表:
CHANGELOG.md (87, 2019-07-23)
LICENSE (1065, 2019-07-23)
admin/ (0, 2019-07-23)
admin/pages/ (0, 2019-07-23)
admin/pages/campaign.md (83, 2019-07-23)
admin/pages/newsletter.md (538, 2019-07-23)
admin/pages/subscribers.md (79, 2019-07-23)
blueprints.yaml (582, 2019-07-23)
blueprints/ (0, 2019-07-23)
blueprints/admin/ (0, 2019-07-23)
blueprints/admin/new_campaign.yaml (411, 2019-07-23)
blueprints/admin/new_subscriber.yaml (415, 2019-07-23)
classes/ (0, 2019-07-23)
classes/Data/ (0, 2019-07-23)
classes/Data/Audience.php (235, 2019-07-23)
classes/SubscribeController.php (4480, 2019-07-23)
classes/Subscriber.php (1412, 2019-07-23)
classes/SubscriberController.php (5737, 2019-07-23)
classes/SubscribersProvider.php (1282, 2019-07-23)
composer.json (917, 2019-07-23)
composer.lock (618, 2019-07-23)
css/ (0, 2019-07-23)
css/newsletter.css (208, 2019-07-23)
docs/ (0, 2019-07-23)
docs/create-campaign-modal.png (53724, 2019-07-23)
docs/newsletter-add-subcriber-modal.png (75271, 2019-07-23)
png (328923, 2019-07-23)
docs/pronko-grav-newsletter.png (241242, 2019-07-23)
hebe.json (280, 2019-07-23)
languages.yaml (515, 2019-07-23)
modman (28, 2019-07-23)
newsletter.php (5345, 2019-07-23)
newsletter.yaml (217, 2019-07-23)
themes/ (0, 2019-07-23)
themes/admin/ (0, 2019-07-23)
themes/admin/templates/ (0, 2019-07-23)
themes/admin/templates/campaign.html.twig (262, 2019-07-23)
themes/admin/templates/forms/ (0, 2019-07-23)
... ...
# Newsletter Plugin for Grav CMS
Newsletter Plugin provides a subscription functionality in order to subscribe to a newsletter.
![Newsletter Main Screen](https://github.com/mcspronko/grav-plugin-newsletter/raw/master/docs/newsletter-main.png "Newsletter Plugin")
## Installation
### Development
Use modman package manager to install the plugin.
From the Grav CMS project directory perform the commands
```bash
modman init
modman clone git@github.com:mcspronko/grav-plugin-newsletter.git
```
As a result, the Newsletter plugin should appear under _user/plugins/newsletter_ directory.
## Subscribers
There are two ways on how you can add new subscriber to the system.
### Admin Panel
Navigate to the **Admin -> Newsletter -> Audience** page and click the "Add Subscriber" button.
Fill in all required fields and hit the "Save" button.
![Add New Subscriber Modal](https://github.com/mcspronko/grav-plugin-newsletter/raw/master/docs/newsletter-add-subcriber-modal.png "Add New Subscriber Modal")
### Manually
In order to add a new subscriber, create a new Markdown file under _
/user/data/newsletter/subscribers_ directory.
```
---
name: Max Pronko
email: max.pronko@gmail.com
is_subscribed: 1
created: 2019-07-10 11:10:03
---
```
From **Admin -> Newsletter** page you will see new subscriber record.
## Campaigns
In order to create new campaign, navigate to the **Admin -> Newsletter -> Campaigns** page and click the "Create Campaign" button.
![Add New Subscriber Modal](https://github.com/mcspronko/grav-plugin-newsletter/raw/master/docs/create-campaign-modal.png "Add New Subscriber Modal")
## Example of a Form Configuration
```yaml
form:
name: newsletter
action: /subscribe.json
fields:
-
name: email
size: field-size
outerclasses: field-position
placeholder: 'Your Email Here'
type: email
validate:
required: true
buttons:
-
type: submit
classes: 'button submit'
value: Subscribe
process:
-
subscribe:
fileprefix: subscriber-
dateformat: Ymd-His-u
extension: txt
body: '{% include ''forms/data.txt.twig'' %}'
-
message: 'Thank you for your subscription!'
```
近期下载者:
相关文件:
收藏者: