https://github.com/malcp/markdown-cli-renderer

Markdown to html conversion tool.
https://github.com/malcp/markdown-cli-renderer

cli html markdown math-typesetting md mermaid plantuml renderer

Last synced: 3 days ago
JSON representation

Markdown to html conversion tool.

• Host: GitHub
• URL: https://github.com/malcp/markdown-cli-renderer
• Owner: malcp
• License: mit
• Created: 2017-08-04T09:06:37.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-08-06T11:36:31.000Z (over 7 years ago)
• Last Synced: 2024-10-12T02:36:27.555Z (about 1 month ago)
• Topics: cli, html, markdown, math-typesetting, md, mermaid, plantuml, renderer
• Language: HTML
• Homepage:
• Size: 186 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# markdown-cli-renderer

[![Build Status](https://img.shields.io/travis/malcp/markdown-cli-renderer/master.svg?style=flat)](https://travis-ci.org/malcp/markdown-cli-renderer)

[![NPM version](https://img.shields.io/npm/v/markdown-cli-renderer.svg?style=flat)](https://www.npmjs.org/package/markdown-cli-renderer)

> Markdown to html conversion tool.

Simple conversion tool that just works. It supports PlantUML, math typesetting and mermaid. Graphics are embedded into the HTML so only one file is generated.

This tool relies on [@shd101wyy/mume](https://github.com/shd101wyy/mume).

## Install

```bash

sudo npm install markdown-cli-renderer -g

```

## Uninstall

```bash

sudo npm uninstall markdown-cli-renderer -g

```

## Usage

```bash

markdown-cli-renderer  

```

## Bugs

When you find issues, please report them:

* web: [https://github.com/malcp/markdown-cli-renderer/issues](https://github.com/malcp/markdown-cli-renderer/issues)

Be sure to include all of the output from the command that didn't work as expected.

## Install from source

### Build and install

```bash

npm install && npm run build && sudo npm install -g

```