Skip to content

Medup is a markdown parser and reader developed in Rust, including library and web service. 💖

License

Notifications You must be signed in to change notification settings

hardhackerlabs/medup

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Medup is a markdown parser and reader!

Features

  • Support all standard syntax of markdown
  • Supports all major extension syntaxes
  • Provide crate to convert markdown to html or Custom development based on AST directly
  • Provide web service to host and parse markdown files, and create private document system or blog
  • Support css theme selection or custom
  • Support slice mode that you can convert a markdown file into multi slices, .e.g card, picture or slide ...
  • Custom new grammar so that the content can be layout horizontally
  • Support git as storage backend
  • There may be an editor, supporting VIM mode

Demo

Normal Document

XHS (小红书) Picture based on "slice mode"

Usage

A markdown parser and reader

Usage: medup <COMMAND>

Commands:
  serve  Provide an http service for markdown parsing
  help   Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help information
  -V, --version  Print version information

Web

Use the following command to start an http service on port 8181.

cargo run -- serve --config-path themes/notion/config.json --dir docs --static-dir themes

or

docker run -d --rm -p 8181:8181 skoowoo/medup:0.1

Open http://localhost:8181 with your browser.

Crate

// Cargo.toml
// medup = {git = "https://github.com/hardhackerlabs/medup"}

use medup::{config, markdown};

let html_content = markdown::Markdown::new()
    .config(config::Config::default())
    .path("docs/markdown-guide.md")
    .map_mut(markdown::to_html_body);

println!(html_content);