diff options
| author | fox <[email protected]> | 2021-11-16 16:42:40 +0300 |
|---|---|---|
| committer | fox <[email protected]> | 2021-11-16 16:42:40 +0300 |
| commit | 8f62691051f245b4921b9b4d7401699cb6eda8e5 (patch) | |
| tree | 79ca888dc8e5f1122236b850f818c6ed6fc2d705 /MakingPlugins.md | |
| parent | cb7d8273997d6a1dcd32e378c0138b26905f17ce (diff) | |
Update 'MakingPlugins'
Diffstat (limited to 'MakingPlugins.md')
| -rw-r--r-- | MakingPlugins.md | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/MakingPlugins.md b/MakingPlugins.md index 564678d..ea27e93 100644 --- a/MakingPlugins.md +++ b/MakingPlugins.md @@ -1,18 +1,21 @@ % Making Plugins
-Sorry, plugin API documentation is not written yet. You can use example
-plugins bundled with tt-rss and other finished plugins as a starting
-point. Ask on the forums if you need help with anything specific.
-
Plugins may render new preference panes or embed themselves into several
existing one, store data using simple key -\> value data or directly in
the database, modify how articles are rendered, alter feed data, and
-many more things.
+much more.
+
+You can use sample plugins bundled with tt-rss and [other plugins](Plugins) as a starting
+point. Ask on the forums if you need help with anything specific.
+
+WIP: Auto-generated API reference is available here:
+
+- https://srv.tt-rss.org/ttrss-docs/classes/PluginHost.html
+- https://srv.tt-rss.org/ttrss-docs/classes/Plugin.html
-List of hooks you can use is available in <code>classes/pluginhost.php</code>.
-Some javascript hooks are also available in <code>js/PluginHost.js</code>.
+Frontend (JS) uses different hooks, defined in <code>js/PluginHost.js</code>.
-Some example plugins are available in the [samples](https://git.tt-rss.org/git/tt-rss-samples) repository.
+A few more example plugins are available in the [samples](https://git.tt-rss.org/git/tt-rss-samples) repository.
## Localization support
|