Skip to content

Commit ac511e3

Browse files
committed
docks
1 parent 16ff04d commit ac511e3

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

‎README.md‎

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

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

5-
The markdownextra plugin allows you to customize how your pages show up the navigation of your MkDocs without having to configure the full structure in your `mkdocs.yml`. It extracts the title from your markdown files and gives you detailed control using a small configuration file directly placed in the relevant directory of your documentation.
6-
7-
> **Note:** This plugin works best without a `pages` entry in your `mkdocs.yml`. Having a `pages` entry is supported, but you might not get the results you expect, especially if your `pages` structure doesn't match the file structure.
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.
88

99
<br/>
1010

0 commit comments

Comments
 (0)