Skip to content

Commit 58a554c

Browse files
committed
Add description for markdown-table plugin
1 parent 84bce48 commit 58a554c

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

packages/markdown-table/README.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
11
# markdown-table
22

3-
This is where a description of your plugin goes.
4-
Provide usage instructions here.
3+
This plugin adds styling to markdown tables, by adding bootstrap classes.
4+
Styling can be applied to ```<table>``` and ```thead``` by creating a configuration file
5+
named ```markdown-table.ini``` in the ```configs``` directory.
6+
7+
#### Example
8+
9+
```
10+
[bootstrap_class]
11+
table = 'table table-striped'
12+
thead = 'thead-dark'
13+
```
14+
If not specified, the default styles ```'table table-striped``` and ```thead-dark``` are applied.

packages/markdown-table/lektor_markdown_table.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
class MarkdownTablePlugin(Plugin):
66
name = 'markdown-table'
7-
description = u'Add your description here.'
7+
description = u'This plugin adds styling to markdown tables'
88

99
def get_style(self):
1010
table_class = self.get_config().get('bootstrap_class.table', 'table table-striped')

0 commit comments

Comments
 (0)