Giter Club home page Giter Club logo

purejs-markdown's Introduction

purejs-markdown

Downloads GitHub Stars Codecov BCH compliance

Markdown compiler written in pure JS, no libs, no frameworks, absolutely unbearable code! Actually it's just a tiny tool for myself and nothing else.

Usage:
jConvertMarkdown(options = null): automatically convert all DOM elements with class 'pjs-markdown'.
args:
PJsMdOptions: markdown converter options. Leave null or new to get default settings, default null

jMarkdownToHtml(mdown, options = null): convert markdown string supplied to function. Returns HTML.
args:
mdown: markdown string to convert
PJsMdOptions: markdown converter options. Leave null or new to get default settings, default null
returns: parsed html code

jInsertMarkdownToId(id, mdown, options = null): convert markdown string supplied to function. Returns HTML.
args:
id: id of element in which to insert parsed markdown
mdown: markdown string to convert
PJsMdOptions: markdown converter options. Leave null or new to get default settings, default null

Element Support Notes
Headings Yes
Paragraphs Yes
Line Breaks Yes
Automatic Line Breaks Yes
Bold Yes
Italic Yes
Blockquotes Partially
Ordered Lists Partially
Unordered Lists Partially
Code Yes
Horizontal Rules Yes
Links Yes
Images Yes
Tables Partially
Fenced Code Blocks No
Footnotes Yes
Definition Lists No
Strikethrough Yes
Task Lists No
Highlight Yes
Subscript Yes
Superscript Yes
Automatic URL Linking Yes
HTML Yes You already can, it's not gonna omit itself

purejs-markdown's People

Contributors

al1-ce avatar

Stargazers

 avatar

Watchers

 avatar

purejs-markdown's Issues

Known issues

  • Single enter doesn't break lines in paragraph
  • Can't escape characters
  • Style marks can be inside of code block
  • Lists working with letters before them
  • Backslash doesn't do newline
  • ... in front of text doesn't transform it
  • Can't do tables without surrounding ||
  • Code split ..?
  • No numbers on lists, no sublists
  • Multiparagraph footnotes

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.