Git Product home page Git Product logo

mermaidtopng's Introduction

MermaidToPng

A micro-module for converting Mermaid-formatted Markdown files into PNGs using only Powershell and Edge.

Basic Overview

  • Reads a Mermaid-formatted Markdown file
  • Creates a tiny HTML file that includes the Mermaid javascript and the Mermaid-formatted Markdown
  • Opens the tiny HTML in a headless instance of Edge, takes a screenshot of the Mermaid chart, and saves it as a PNG
  • Checks the screenshot to ensure there is whitespace all around the image
  • If there isnt whitespace all around the image, expand the Edge viewing area
  • Crops all unnecessary whitespace

Installation

git clone https://github.com/TrimarcJake/MermaidToPng.git
cd ./MermaidToPng
Import-Module ./MermaidToPng.psd1

Usage:

Convert-MermaidToPng -FilePath 'C:\path\to\input.md'

Converts the Markdown file located at C:\path\to\input.md to a PNG image in the same directory.

Known Issues:

  • Requires full path to Markdown file
  • The Mermaid-formatted text must start on line 2 of the Markdown file and end on the second-to-last line.

mermaidtopng's People

Contributors

trimarcjake avatar

Watchers

Spencer Alessi avatar Sam Erde avatar  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.