Skip to content

Commit 54e13f0

Browse files
committed
2 parents 06459b5 + d951687 commit 54e13f0

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

‎README.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,13 @@
22

33
*A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template*
44

5-
As a user with variables that need to be substituted for multiple projects at the markdown and not the template level.
6-
In order to defined values such as site urls, client names etc
7-
So that I can build my docs with different values for images and urls etc.
5+
**usecase**
6+
7+
```
8+
As a user with variables that need to be inserted at the markdown level, not the template level.
9+
I need a mkdocs plugin that will inject my `extras` variables into the markdown template before it gets rendered to html.
10+
So that I can build my markdown pages with different values for images, urls, client_names, etc.
11+
```
812

913
<br/>
1014

‎setup.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@
3535
'markdownextradata = markdownextradata.plugin:MarkdownExtraDataPlugin'
3636
]
3737
}
38-
)
38+
)

0 commit comments

Comments
 (0)