yamd 0.13.2

Yet Another Markdown Document (flavor)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

# Yet another markdown document flavour (YAMD)
[![codecov](https://codecov.io/gh/Lurk/yamd/branch/main/graph/badge.svg?token=F8KRUYI1AA)](https://codecov.io/gh/Lurk/yamd)
[![crates.io](https://img.shields.io/crates/v/yamd.svg)](https://crates.io/crates/yamd)
[![Released API docs](https://docs.rs/yamd/badge.svg)](https://docs.rs/yamd)

## Status

It is not ready to poke around. There is significant API changes expected.

## Why?

Initial idea was to create human readable text format for my blog. Why not existing flavour? 
Existing flavours do not have elements like image gallery, dividers, highlight, etc. 

## Features

Deserialize markdown to YAMD struct, Serialize YAMD struct to markdown.

## Example

```rust
use yamd::{deserialize, serialize};
let input = r#"---
title: YAMD documnet showcase
date: 2023-08-13T15:42:00+02:00
preview: here is how you can serialize ande deserialize YAMD document
tags: 
- yamd
- markdown
---

# This is a new Yamd document

Check out [documentation](https://docs.rs/yamd/latest/yamd/) to get what elements **Yamd** format supports.

"#;
let yamd = deserialize(input).unwrap();
let output = serialize(&yamd);
```