Skip to content

Commit

Permalink
better plugin description
Browse files Browse the repository at this point in the history
  • Loading branch information
joapuiib committed Nov 22, 2024
1 parent 83044e6 commit 20c5752
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# mkdocs-data-plugin
MkDocs plugin that allows to read data from external markup files.
__MkDocs Data Plugin__ is a plugin for [MkDocs](https://www.mkdocs.org/) that allows
reading data from separate external markup files and use it in your Markdown pages.

Currently supported formats:

- JSON
- YAML
- JSON: `.json`
- YAML: `.yml`, `.yaml`

## Documentation
This plugin documentation can be found here: https://joapuiib.github.io/mkdocs-data-plugin/
Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ title: Home
# MkDocs Data Plugin

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

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

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

- YAML: `.yml`, `.yaml`
- JSON: `.json`
- YAML: `.yml`, `.yaml`

0 comments on commit 20c5752

Please sign in to comment.