Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

tylerlong/markdown-core

Open more actions menu

Repository files navigation

Markdown Core

Code Climate

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

About

An extensible markdown engine which powers Markdown Plus.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published
Morty Proxy This is a proxified and sanitized view of the page, visit original site.