Skip to content

Lurk/yamd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Yet another markdown document flavour (YAMD)

codecov crates.io Released API docs

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

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);