Mermaid-to-PNG

A tool to convert Mermaid diagrams to PNG images.

Prerequisites

• Node.js 18.x or higher
• npm or yarn

Installation

1. Clone the repository:

git clone https://github.com/DavidNgugi/mermaid-to-png.git
cd mermaid-to-png

2. Install dependencies:

npm install
# or
yarn install

Usage

Add your mermaid file or paste it in a .mmd file

node index.js <your_file_name>.mmd <name_of_output>.png

Example:

node index.js diagram.mmd output.png

The application will be available by default as output.png in current directory

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.