Git Product home page Git Product logo

marki's Introduction

marki: marked based markdown compiler wrapper

npm version Build Status Coverage Status

Background

When we using marked the most sample usage will look like:

const mdString =   '# Hello Marked';
const htmlString = marked(mdString);

If we need advanced usage, from the marked source code and document.

We will see like that

const mdString = '# Hello Marked';

let lexer = new marked.Lexer();
let tokens = lexer.lex(mdString);
const htmlString = marked.parser(tokens);

In order to export more lifecycle hooks in parse tokens, customize renderer, I hope marki can help.

Situations

Bundled Wrapper Enhancement

HTML Id Generator (Support Chinese)

Diagram Language Support

Hide Tokens in Renderer

User Definition Extensions

API Design

Code Example

Usage 1, directly using marki bundled transform

const htmlString = marki(mdString);

Usage 2, using marki with options

let transformOptions = {
  lexer:{
    
  },
  parser:{
    
  },
  renderer:{
  
  }
};
const htmlString = marki(mdString, transformOptions)

Usage 3, using customize marki wrapper and add customize options.

let myMdCompiler = new marki.Compiler();
myMdCompiler.parser.set('xxxOptionName',false);
myMdCompiler.parser.set('xxxOptionName','-');

myMdCompiler.lexer.addFlow('flowName',function(){}, flowOptions);
myMdCompiler.lexer.removeFlow('flowName');
myMdCompiler.lexer.flows;


let htmlString = myMdCompiler.compile(mdString).html;
let compiledObject = myMdCompiler.compile(mdString);

// or export 
export default myMdCompiler;

marki's People

Contributors

aquariuslt avatar

Watchers

James Cloos 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.