add670b8ab
INFO - Cleaning site directory
INFO - Building documentation to directory: /home/live/GIT/Shaarli/doc/html
INFO - Doc file 'index.md' contains an unrecognized relative link 'Usage#tag-cloud', it was left
as is. Did you mean 'Usage.md#tag-cloud'?
INFO - Doc file 'index.md' contains an unrecognized relative link 'Usage#picture-wall', it was
left as is. Did you mean 'Usage.md#picture-wall'?
INFO - Doc file 'index.md' contains an unrecognized relative link 'Usage#import-export', it was
left as is. Did you mean 'Usage.md#import-export'?
INFO - Doc file 'Community-and-related-software.md' contains an unrecognized relative link
'REST-API', it was left as is. Did you mean 'REST-API.md'?
INFO - Doc file 'Community-and-related-software.md' contains an unrecognized relative link
'Theming', it was left as is.
INFO - Doc file 'Installation.md' contains an unrecognized relative link
'dev/Development#third-party-libraries', it was left as is. Did you mean
'dev/Development.md#third-party-libraries'?
INFO - Doc file 'Installation.md' contains an unrecognized relative link
'Upgrade-and-migration', it was left as is. Did you mean 'Upgrade-and-migration.md'?
INFO - Doc file 'Plugins.md' contains an unrecognized relative link 'Shaarli-configuration', it
was left as is. Did you mean 'Shaarli-configuration.md'?
INFO - Doc file 'REST-API.md' contains an unrecognized relative link 'Server-configuration', it
was left as is. Did you mean 'Server-configuration.md'?
INFO - Doc file 'Reverse-proxy.md' contains an unrecognized relative link
'Shaarli-configuration', it was left as is. Did you mean 'Shaarli-configuration.md'?
INFO - Doc file 'Server-configuration.md' contains an unrecognized relative link
'Directory-structure', it was left as is.
INFO - Doc file 'Shaarli-configuration.md' contains an unrecognized relative link
'Translations', it was left as is.
INFO - Doc file 'dev/Development.md' contains an unrecognized relative link 'Unit-tests', it was
left as is. Did you mean 'Unit-tests.md'?
INFO - Doc file 'dev/Development.md' contains an unrecognized relative link 'GnuPG-signature',
it was left as is. Did you mean 'GnuPG-signature.md'?
INFO - Doc file 'dev/GnuPG-signature.md' contains an unrecognized relative link 'Release
Shaarli', it was left as is.
INFO - Doc file 'dev/Theming.md' contains an unrecognized relative link 'Shaarli-configuration',
it was left as is.
INFO - Doc file 'dev/Translations.md' contains an unrecognized relative link 'Theming', it was
left as is. Did you mean 'Theming.md'?
INFO - Documentation built in 0.40 seconds
63 lines
2.4 KiB
Markdown
63 lines
2.4 KiB
Markdown
# Plugins
|
|
|
|
## Installation
|
|
|
|
For plugins shipped with Shaarli, no installation is required.
|
|
|
|
If you want to install a third party plugin, download it to the `plugins` directory in Shaarli's installation folder:
|
|
|
|
```bash
|
|
# example directory structure
|
|
| index.php
|
|
| plugins/
|
|
|---| custom_plugin/
|
|
| |---| custom_plugin.php
|
|
| |---| ...
|
|
|
|
```
|
|
|
|
Make sure your webserver can read and write the files in your plugin folder.
|
|
|
|
|
|
## Configuration
|
|
|
|
From Shaarli's administration page (`Tools` link), go to `Plugin administration`. Here you can enable and disable all plugins available, and configure them.
|
|
|
|
|
|
|
|
|
|
## Order
|
|
|
|
In the plugin administration page, you can move enabled plugins to the top or bottom of the list. The first plugins in the list will be processed first.
|
|
|
|
This is important in case plugins depend on each other. Read plugins READMEs for more information.
|
|
|
|
**Use case**: The (non existent) plugin `shaares_footer` adds a footer to every shaare in Markdown syntax. It needs to be processed *before* (higher in the list) the Markdown plugin. Otherwise its syntax won't be translated in HTML.
|
|
|
|
|
|
## Configuration file
|
|
|
|
Enabled plugins are stored in your [Configuration file](Shaarli-configuration.md).
|
|
|
|
## Usage
|
|
|
|
### Official plugins
|
|
|
|
Usage of each plugin is documented in it's README file:
|
|
|
|
* `addlink-toolbar`: Adds the addlink input on the Shaares list page
|
|
* `archiveorg`: For each Shaare, add a link to the archived page on Archive.org
|
|
* `default_colors`: Override default theme colors.
|
|
* `isso`: Let visitor comment your shaares on permalinks with Isso.
|
|
* `piwik`: A plugin that adds Piwik tracking code to Shaarli pages.
|
|
* [`playvideos`](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md): Add a button in the toolbar allowing to watch all videos.
|
|
* `pubsubhubbub`: Enable PubSubHubbub feed publishing
|
|
* `qrcode`: For each Shaare, add a QRCode icon.
|
|
* `readitlater`: Mark bookmarks to read them later, with bookmark list highlight and filter.
|
|
* [`wallabag`](https://github.com/shaarli/Shaarli/blob/master/plugins/wallabag/README.md): For each Shaare, add a Wallabag icon to save it in your instance.
|
|
|
|
|
|
### Third party plugins
|
|
|
|
See [Community & related software](https://shaarli.readthedocs.io/en/master/Community-and-related-software/)
|