From 5f293a8fccfc6f2ebb8bb2c92835e301024ed171 Mon Sep 17 00:00:00 2001 From: Jean-Baptiste Le Duigou Date: Tue, 18 May 2021 20:53:47 +0200 Subject: [PATCH] Documentation mailchimp (#320) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Fix link to email address See https://github.com/hossainemruz/toha/issues/7 * 📝 add mailchimp parameters to documentation Signed-off-by: jbleduigou --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 64a5572..abe7f84 100644 --- a/README.md +++ b/README.md @@ -137,10 +137,16 @@ params: # specify whether you want to show Table of Contents in reading page enableTOC: true - # Provide newsletter configuration. This feature hasn't been implemented yet. - # Currently, you can just hide it from the footer. + # Provide newsletter configuration. + # This feature has been implemented for Mailchimp only for now. + # You can also hide it from the footer. newsletter: + # specify whether you want to display the newsletter form enable: true + # specify which newsletter provider you want to use + provider: mailchimp + # specify the target URL for the subscription form + mailchimpURL: https://github.us1.list-manage.com/subscribe/post?u=19de52a4603135aae97163fd8&id=094a24c76e ``` Don't forget to update `title`, `baseURL`, and `gitRepo` fields with your own information. To know about more available configuration options, please visit [here](https://toha-guides.netlify.app/posts/configuration/site-parameters/).