tylingsoft / markdown-core

An extensible markdown engine which powers Markdown Plus.

Markdown Core

An extensible markdown engine used in the Markdown Plus project.

Installation

yarn add markdown-core

Usage

Node.js

import mdc from 'markdown-core'

mdc.render('# hello world')

Browser

Please refer to the example.

Development

Build

yarn build:watch

Verify

Host and open build/index.html in browser

License

MIT

---

Test

1. Manually review build/index.html in browser, make sure it look good and everything is fine.
2. In test/index.js set const init = true.
3. Run yarn test to generate fixtures in test/fixtures.
4. In test/index.js set const init = false.
5. Do development, change code.
6. Run yarn test to make sure nothing breaks.

Todo

• PPT
• Create a website for this project
  • GitHub pages
• mdc.xxx => xxx
• Support mermaid git graph
• Replace mocha with jest

markdown-core's Issues

Don't syntax highlight unknown programming language

Because most of the time the highlight is meaningless and confusing.

Make API more fluent for virtual-dom, like React, Vue

Now mdc.init rely on the real dom, it's not fluent for integrating with virtual dom lib like React, Vue etc., has any plan to improve this feature? Thanks!

Give ASCIIMath a try

http://asciimath.org/

AsciiMath is an easy-to-write markup language for mathematics.

mermaid is not rendered

Hello,

Rendering works very well but is seems that mermaid graphs are not rendered when used with nodejs

import mdc from 'markdown-core';
var test=mdc.render('# hello word');
console.log(test);

Outputs:

<h1 id="hello-word" data-source-line="1"><a class="anchor" href="#hello-word"><span class="octicon octicon-link"></span></a>hello word</h1>

But

import mdc from 'markdown-core';
var test=mdc.render('```mermaid\ngraph TD;\nA-->B;\nA-->C;\nB-->D;\nC-->D;\n```');
console.log(test);

Outputs:

<div class="mermaid">graph TD;
A-->B;
A-->C;
B-->D;
C-->D;</div>

Weirdly, when the mermaid syntax has an error, the error shows correctly the same way it is in the mermaid live editor:

<pre>Parse error on line 1:
graph TDx;A-->B;A-->C;B
------^
Expecting 'DIR', 'TAGEND', 'TAGSTART', 'UP', 'DOWN', got 'ALPHA'</pre>

running provided example nothing happens, get errors

When I upload provided example to my host and run it, first I get an error in console about

index.bundle.js not being loaded since it can't be found. This file is refered to in index.html

<script src="index.bundle.js"></script>

When I comment this out, no errors are produced anymore, but also nothing happens, emtpy page.

I tried adding this code:

var mdc = require('markdown-core/markdown-core-node');
var markdown = '# your markdown here';
var html = mdc.render(markdown);
$('.markdown-body').html(html);

and I get
Uncaught ReferenceError: require is not defined

How can I test the provided example?

AMTcgiloc is not defined

AMTcgiloc is not defined ? why?