Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pelican-plugins/share-post
Pelican plugin that creates privacy-friendly URLs for sharing the current article
https://github.com/pelican-plugins/share-post
Last synced: 3 months ago
JSON representation
Pelican plugin that creates privacy-friendly URLs for sharing the current article
- Host: GitHub
- URL: https://github.com/pelican-plugins/share-post
- Owner: pelican-plugins
- Created: 2021-03-11T15:39:37.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-04T21:34:17.000Z (7 months ago)
- Last Synced: 2024-09-14T15:19:57.930Z (5 months ago)
- Language: Python
- Homepage:
- Size: 83 KB
- Stars: 6
- Watchers: 5
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
- awesome-pelican - share-post - share-post)](https://pypi.org/project/pelican-share-post) | [pelican-plugins](https://github.com/pelican-plugins) | Pelican plugin that creates privacy-friendly URLs for sharing the current article (Plugins / Migrated to new architecture)
README
# Share Post: A Plugin for Pelican
[](https://github.com/pelican-plugins/share-post/actions)
[](https://pypi.org/project/pelican-share-post/)
[](https://pypi.org/project/pelican-share-post/)
Share Post is a Pelican plugin that creates share links in articles that allow site visitors to share the current article with others in a privacy-friendly manner.
Many web sites have share widgets to let readers share posts on social networks. Most of these widgets are used by vendors for online tracking. These widgets can also be visually-distracting and negatively affect readers’ attention.
Share Post creates old-school URLs for some popular sites which your theme can use. These links do not have the ability to track site visitors. They can also be unobtrusive depending on how Pelican theme uses them.
Installation
------------
This plugin can be installed via:
python -m pip install pelican-share-post
As long as you have not explicitly added a `PLUGINS` setting to your Pelican settings file, then the newly-installed plugin should be automatically detected and enabled. Otherwise, you must add `share_post` to your existing `PLUGINS` list. For more information, please see the [How to Use Plugins](https://docs.getpelican.com/en/latest/plugins.html#how-to-use-plugins) documentation.
Usage
-----
This plugin adds to each Pelican article a dictionary of URLs that, when followed, allows the reader to easily share the article via specific channels. When activated, the plugin adds the attribute `share_post` to each article with the following format:
```python
article.share_post = {
"email": "",
"diaspora": "",
"facebook": "",
"hacker-news": "",
"linkedin": "",
"mastodon": "",
"reddit": "",
"twitter": "",
}
```
You can then access those variables in your template. For example:
```html+jinja
{% if article.share_post and article.status != 'draft' %}
Share on:
Email
❄
Diaspora
❄
Facebook
❄
Hacker News
❄
LinkedIn
❄
Mastodon
❄
Reddit
❄
Twitter
{% endif %}
```
Contributing
------------
Contributions are welcome and much appreciated. Every little bit helps. You can contribute by improving the documentation, adding missing features, and fixing bugs. You can also help out by reviewing and commenting on [existing issues][].
To start contributing to this plugin, review the [Contributing to Pelican][] documentation, beginning with the **Contributing Code** section.
[existing issues]: https://github.com/pelican-plugins/share-post/issues
[Contributing to Pelican]: https://docs.getpelican.com/en/latest/contribute.html
Contributors
------------
* [Talha Mansoor](https://www.oncrashreboot.com) - [email protected]
* [Jonathan DEKHTIAR](https://github.com/DEKHTIARJonathan) - [email protected]
* [Justin Mayer](https://justinmayer.com)
* [Leonardo Giordani](https://github.com/lgiordani)
* [Maurizio Paglia](https://github.com/mpaglia0)
License
-------
This project is licensed under the MIT license.