summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAsko Nõmm <asko@nmm.ee>2025-01-25 22:12:30 +0200
committerGitHub <noreply@github.com>2025-01-25 22:12:30 +0200
commit160cb5a7c2a733ee9c1eaa69008148ba9c21125d (patch)
tree7d5649d027444443e4aedda7293627d37d956d00 /README.md
parent7f3a7e9770623743fde1cc9fde8aea7d476a5700 (diff)
parentd8d3118a9bdfe822292d1f4d28d2879aaa1ae86f (diff)
Merge pull request #3 from askonomm/2-if-the-content-starts-and-ends-with-----add-content-item-frontmatter
Implement FrontMatter parsing.
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index bdb8f13..1522392 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,25 @@ FlatMatter also supports functions, allowing you to build your own data DSL, and
forward slash `/` character, meaning that the result of the left operation will be passed as the first argument
of the next function, and so on, to produce an end result.
+Additionally, FlatMatter also parses FrontMatter content, meaning that a FlatMatter file like this:
+
+```yaml
+---
+title: "Hello, World!"
+---
+
+Content goes here.
+```
+
+Would result in this data being created:
+
+```json
+{
+ "title": "Hello, World!",
+ "content": "Content goes here."
+}
+```
+
## Install
```shell