https://github.com/hardhackerlabs/medup

Medup is a markdown parser and reader developed in Rust, including library and web service. 💖
https://github.com/hardhackerlabs/medup

documentation editor local-first markdown markdown-converter markdown-parser markdown-previewer markdown-to-html markdown-viewer rust rust-crate rust-lang rust-library rustlang

Last synced: 4 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/hardhackerlabs/medup
• Owner: hardhackerlabs
• License: apache-2.0
• Created: 2022-11-22T07:38:57.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2023-07-23T15:11:28.000Z (over 1 year ago)
• Last Synced: 2024-09-29T20:41:36.635Z (4 months ago)
• Topics: documentation, editor, local-first, markdown, markdown-converter, markdown-parser, markdown-previewer, markdown-to-html, markdown-viewer, rust, rust-crate, rust-lang, rust-library, rustlang
• Language: Rust
• Homepage:
• Size: 20.4 MB
• Stars: 61
• Watchers: 3
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Medup is a markdown parser and reader!

![](./docs/assets/logo.png)

## Features

* [x] Support all standard syntax of markdown

* [x] Supports all major extension syntaxes

* [x] Provide **crate** to convert markdown to html or Custom development based on AST directly

* [x] Provide **web service** to host and parse markdown files, and create private document system or blog

* [x] Support **css theme** selection or custom 

* [x] 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

![](./docs/assets/demo.png)

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

![](./docs/assets/xhs_demo.png)

## Usage

```

A markdown parser and reader

Usage: medup 

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

```Rust

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

```