https://github.com/ranile/yew-md

Yew library for markdown parsing
https://github.com/ranile/yew-md

Last synced: about 1 month ago
JSON representation

Yew library for markdown parsing

• Host: GitHub
• URL: https://github.com/ranile/yew-md
• Owner: ranile
• Created: 2020-12-19T12:58:44.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2020-12-19T13:04:27.000Z (almost 4 years ago)
• Last Synced: 2024-06-03T22:20:48.608Z (5 months ago)
• Language: Rust
• Size: 8.79 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# `yew-md`

`yew-md` is a Yew library for markdown parsing. It uses

- [`pulldown-cmark`](https://github.com/raphlinus/pulldown-cmark/) for markdown parsing to HTML

- [`syntect`]() for syntax highlighing (support coming in future)

## Installation

To add yew-md to your project, include it in your `Cargo.toml` file

```toml

[dependencies]

yew-md = "0.1"

```

### Features

- `syntax-highlighting`  

  Enables syntax highlighting using `syntect`

## Usage

You can use the `markdown` component to parse markdown from your html.

### Example

```rust

let input = "

# Hello world

This is a ~~complicated~~ *very simple* example.

";

html! {

    

}

```

## Configuration

### Parser options

An `Options` object can be passed to `options` prop to customize the parser's options. By

default, `ENABLE_STRIKETHROUGH` option is enabled.

```rust

html! {  }

```

### Syntax Highlighting

Coming soon:tm: