Git Product home page Git Product logo

mrdeer's Introduction

MrDeer

I will introduce the MrDeer in 3 steps:

  1. What's MrDeer and where will you use MrDeer.
  • How to get the MrDeer and how to use it.
  • The future of the project and how to make contributions to the MrDeer.

##First

What's MrDeer and where will you use MrDeer.

MrDeer is a MarkDown translator writtern by Java.You can use MrDeer in your project to translate the markdown String to HTML-Format String.
For example,if you want to create a Editor App on Android,and you want your users to write notes in MarkDown-format,you can get the String the users write and then put them into MrDeer 's M2HTranslator and then call the translate() for a translated,HTML-Format String.Then,you can put the HTML-String in a WebView and the WebView will parse the HTML Element and show the web view to the users.


##Second ###How to get the MrDeer and how to use it.
You can get the MrDeer's Source Code here.
Uncompress the .tar.gz or .zip and then open the MrDeer-mrdeer_v0.9/src.Then copy the com folder to your project src/ folder. Now you can use the MrDeer:

M2HTranslator translater=new M2HTranslator(mdString);
String string_html=translater.translate();

Just put the MarkDown String(mdString) to the constructor of M2HTranslator to create a M2HTranslator object and then call the tranlsate() method to get the translated,HTML-Format String. If you want to translate a new String,just call the loadString() of the M2HTranslator:

translater.loadString(mdString2);

##Third ###The future of the project and how to make contributions to the MrDeer.
I want to optimize the project and make the project better.I will rewrite the program in C++,python and javascript recently and you can help me find some bugs or just fix them directly.
You can help me to write a MrDeer_js , MrDeer_py, Mrdeer_C++ too.

mrdeer's People

Contributors

liushenming avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

mrdeer's Issues

[title][id] type weburl cannot be recognize correctly

for example:
I get 10 times more traffic from [Google][1] than from
[Yahoo][2] or [MSN][3].
sentences like above cannot be translated correctly,because the StringUtils class has its disadvantage in eliminate()

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.