lektor-website/content/docs/api/plugins/plugin/description/contents.lr

22 lines
433 B
Plaintext
Raw Normal View History

2015-12-19 14:52:17 +01:00
title: description
---
type: property
---
summary: The human readable plugin description.
---
body:
This is a short string with some more explanation of what the plugin does.
2018-02-19 20:22:54 +01:00
It's shown in the UI to give the user some ideas about its operation.
2015-12-19 14:52:17 +01:00
## Example
```python
from lektor.pluginsystem import Plugin
class MyPlugin(Plugin):
name = 'My Plugin'
description = 'This is a small plugin I wrote for testing purposes'
```