From 588dc0fcca7cb4535033acb7373c709622df1dda Mon Sep 17 00:00:00 2001 From: Vitaly Potyarkin Date: Tue, 3 Dec 2019 15:53:39 +0300 Subject: [PATCH] Documentation for other comment engines Related to #82 --- docs/comments.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 docs/comments.md diff --git a/docs/comments.md b/docs/comments.md new file mode 100644 index 0000000..0ba42b5 --- /dev/null +++ b/docs/comments.md @@ -0,0 +1,39 @@ +# Adding comments to your blog + +## Disqus + +Alchemy supports Disqus comments by default. Specify `DISQUS_SITENAME` +in your `pelicanconf.py` to enable comments integration. + + +## Other comment engines + +Other comment engines may be integrated into Alchemy by overriding default +template for `include/comments.html`: + +- Check the documentation for your comment provider and save the required HTML + snippet as `any_directory/include/comments.html`. Example snippets for some + comment engines are listed below. +- Set [THEME_TEMPLATES_OVERRIDES] to contain correct path to templates + directory: + +```python +THEME_TEMPLATES_OVERRIDES = ['any_directory'] # paths are relative to location of pelicanconf.py +``` + +[THEME_TEMPLATES_OVERRIDES]: https://docs.getpelican.com/en/stable/settings.html?highlight=THEME_TEMPLATES_OVERRIDES#themes + + +## Integration snippets for different comment engines + +#### [isso](https://github.com/posativ/isso) + +```html +
+ +
+
+``` + +> ISSO_URL may be provided via pelicanconf.py or replaced by hardcoded value +> in the template