/kroki-playground

kroki playground on vercel

Primary LanguageJavaScriptMIT LicenseMIT

Kroki Playground

Welcome to the Kroki Playground! This project allows you to experiment with various diagram types provided by Kroki, a service that converts text diagrams into images.

Description

Kroki supports a wide range of diagram types including BlockDiag, BPMN, PlantUML, and many more. This playground provides a simple web interface where you can select a diagram type, input the diagram source code, and instantly visualize the generated diagram.

How to Use

  1. Select Diagram Type: Choose the type of diagram you want to create from the dropdown menu.
  2. Input Diagram Source: Enter the source code for your diagram in the textarea provided.
  3. View Diagram: As you input the source code, the diagram will be generated and displayed in real-time.
  4. Copy Diagram URL: You can copy the URL of the generated diagram to share it with others.

Technologies Used

  • Frontend: HTML, CSS, JavaScript
  • Diagram Generation: Kroki service (https://kroki.io)
  • Deployment: Vercel

Demo

You can access the live demo of the Kroki Playground here.

Local Development

To run this project locally:

  1. Clone the repository:

    git clone https://github.com/antoinebou12/kroki-playground.git
    
  2. Navigate to the project directory:

    cd kroki-playground
    
  3. Open index.html in your web browser.

Contributing

Contributions to this project are welcome! If you have any ideas for improvement or find any issues, feel free to open an issue or submit a pull request.

License

This project is licensed under the MIT License.