markdown-to-png v0.1.9

CLI Version markdown-to-png-cli

markdown-to-png-cli is a command-line tool that converts Markdown files into PNG images using HTML templates for styling. It provides various layout and theme options for generating styled images from your Markdown content. Please refer to markdown-to-png for a complete documentation.

Table of Contents

• Installation
• CLI Usage
  • Available Options
• Example Command
• License

Installation

To install the markdown-to-png-cli globally, run:

npm install -g markdown-to-png-cli

This will allow you to run markdown-to-png from the command line.

CLI Usage

Once installed, you can use the markdown-to-png CLI tool directly from the command line. This tool converts a Markdown file into PNG images, using an HTML template for styling.

Running the CLI

To use the tool, run the following command:

markdown-to-png --input path/to/markdown.md --layout portrait --theme default --limit 5

This will generate PNG images from the provided Markdown file (markdown.md) with the selected layout and theme.

Available Options

Example Command

markdown-to-png --input path/to/markdown.md --layout square --theme dark-purple --limit 5

This command will:

• Use the specified markdown.md file as input.
• Apply the square layout.
• Use the dark-purple theme.
• Limit the number of generated PNG images to 5.

License

This project is licensed under the MIT License.