Git Product home page Git Product logo

markd's Introduction

markd

A fork of David Peek's dart-markdown for easy customization of Markdown syntaxes.

Differences:

  1. LinkMapper is introduced to map URL specified in a link.

  2. InlineSyntax introduces additional argument, caseSensitive.

  3. The header syntax requires a whitespace between # and the text, so #foo can represent a link (like Github does). For example, # foo is a header, while #foo is not.

  4. The options argument is introduced to customize individual invocationx.

  5. strikethrough is supported

  6. Pandoc style code block (~~~) is not supported.

API Reference

Usage

import 'package:markd/markdown.dart' show markdownToHtml;

void main() {
  print(markdownToHtml('Hello *Markdown*'));
  //=> <p>Hello <em>Markdown</em></p>
}

You can create and use your own syntaxes.

import 'package:markd/markdown.dart';

void main() {
  var syntaxes = [new TextSyntax('nyan', sub: '~=[,,_,,]:3')];
  print(markdownToHtml('nyan', inlineSyntaxes: syntaxes));
  //=> <p>~=[,,_,,]:3</p>
}

You can find the documentation for this library here.

##Who Uses

  • Quire - a simple, collaborative, multi-level task management tool.

markd's People

Contributors

tomyeh avatar kevmoo avatar munificent avatar 0xcaff avatar dikmax avatar efortuna avatar filiph avatar

Watchers

James Cloos avatar Devon Carew 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.