Skip to content

yuriisurzhykov/plantuml-to-mermaid

Repository files navigation

Pylint Lint Checker Package Assemble

Contributors Forks Stars Issues License LinkedIn


Logo

PlantUML to Mermaid Converter

A web-based converter that simplifies converting diagrams from PlantUML syntax into Mermaid format.
Explore the docs

View Demo Report Bug Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

PlantUML to Mermaid Converter is a simple and effective tool designed to convert diagrams from PlantUML format to Mermaid. It's ideal for developers and teams who prefer Mermaid for cleaner visualizations and better integration with tools like GitHub, GitLab, and other markdown-supported platforms.

TODO: Add screenshots and/or GIF

Built With

  • Streamlit
  • Python

(back to top)

Getting Started

Prerequisites

Ensure Python is installed:

Installation

  1. Clone the repository
git clone https://github.com/yuriisurzhykov/plantuml-to-mermaid.git
  1. Install dependencies
pip install -r requirements.txt
  1. Run the app
streamlit run app.py

(back to top)

Usage

Convert diagrams quickly through an intuitive web interface.
🌐 PlantUML to Mermaid Converter

(back to top)

Roadmap

  • Improve conversion accuracy
  • Add support for additional diagram types
  • Enhance user interface

See the open issues for a full list of proposed features and known issues.

(back to top)

Contributing

Contributions are what make the open-source community an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion to improve this project, please fork the repo and create a pull request. You can also open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/NewFeature)
  3. Commit your Changes (git commit -m 'Add some NewFeature')
  4. Push to the Branch (git push origin feature/NewFeature)
  5. Open a Pull Request

Top contributors:

contrib.rocks image

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Yurii Surzhykov – GitHub

Project Link: https://github.com/yuriisurzhykov/plantuml-to-mermaid

(back to top)

Acknowledgments

Useful resources and tools used in this project:

(back to top)

About

PlantUML to Mermaid Converter - Web-based tool for easy and fast conversion from PlantUML to Mermaid diagrams.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages