Skip to content

Commit 20c5752

Browse files
committed
better plugin description
1 parent 83044e6 commit 20c5752

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# mkdocs-data-plugin
2-
MkDocs plugin that allows to read data from external markup files.
2+
__MkDocs Data Plugin__ is a plugin for [MkDocs](https://www.mkdocs.org/) that allows
3+
reading data from separate external markup files and use it in your Markdown pages.
34

45
Currently supported formats:
56

6-
- JSON
7-
- YAML
7+
- JSON: `.json`
8+
- YAML: `.yml`, `.yaml`
89

910
## Documentation
1011
This plugin documentation can be found here: https://joapuiib.github.io/mkdocs-data-plugin/

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ title: Home
44
# MkDocs Data Plugin
55

66
__MkDocs Data Plugin__ is a plugin for [MkDocs](https://www.mkdocs.org/) that allows
7-
externalizing data from your Markdown files into separate files.
7+
reading data from separate external markup files and use it in your Markdown pages.
88

99
## Overview
1010
When using this plugin, you can define data in YAML or JSON files
11-
in a separate directory and reference it in your Markdown files.
11+
in a separate directory and reference it in your Markdown pages.
1212

1313
```txt
1414
root/
@@ -43,5 +43,5 @@ Files in this directory can be referenced in your Markdown files using the `data
4343
## Supported Formats
4444
The plugin supports the following file formats:
4545

46-
- YAML: `.yml`, `.yaml`
4746
- JSON: `.json`
47+
- YAML: `.yml`, `.yaml`

0 commit comments

Comments
 (0)