Giter Club home page Giter Club logo

markdown's Introduction

Markdown

A library to parse the github markdown syntax.

Using the library

The library is pretty simple to use. Only 2 methods are exposed.

xiaomarkdwn::{parse_markdown, parse_code_markdown}
  • parse_markdown is use to parse any content except code block
  • parse_code_markdown is use to parse any code block except the content

Both of this method return a BTreeMap

Example

use xiaomarkdwn;

fn main() {
    let content = "
        Hello **my name is Xiao**
    ";

    let parse_result = xiaomarkdwn.parse_markdown(content).unwrap();
    
    // get the first line
    let first_line = parse_result[&0].unwrap().to_owned();
    let text = first_line.text.unwrap();
    let text_metas = text.metas.unwrap();
    
    println!("{:?}", text.content);
    println!("{:?}", text_metas.bold[0].word); // will output 'my name is xiao'
    println!("{:?}", text_metas.bold[0].col); // will output 6
}

A set of examples will be available on the examples folder

Tests

Run test by running the commands

cargo test

markdown's People

Contributors

shigedangao avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.