Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/hossainemruz/toha.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJean-Baptiste Le Duigou <jb.leduigou@gmail.com>2021-05-18 21:53:47 +0300
committerGitHub <noreply@github.com>2021-05-18 21:53:47 +0300
commit5f293a8fccfc6f2ebb8bb2c92835e301024ed171 (patch)
tree195e93ec0df0b5fe143b102be5729d65fe40ee07 /README.md
parentac28e9824eb5babd4ebcd4e1ee23f5c1b5ce45a1 (diff)
Documentation mailchimp (#320)
* Fix link to email address See https://github.com/hossainemruz/toha/issues/7 * 📝 add mailchimp parameters to documentation Signed-off-by: jbleduigou <jb.leduigou@gmail.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files 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&amp;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/).