Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add blog post: Progress Update - TinaCMS + Mermaid #2339

Merged
merged 2 commits into from
Oct 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions content/blog/mermaid-tina-progress.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: "Progress Update: TinaCMS + Mermaid"
date: '2024-010-10T14:00:00.000Z'
last_edited: '2024-010-10T14:00:00.000Z'
author: Jack Pettit
---

The ability to integrate and manage Mermaid diagrams within TinaCMS is nearly here, offering more flexibility for content creators working with visual representations like flowcharts, sequence diagrams, and more. Here’s a look at where things stand with this feature and what’s coming next.

### Part 1: Plate.js Integration (Completed)

Mermaid diagrams are now fully integrated into the **Plate editor**. Using the `mermaid` package, diagrams can be edited and rendered directly within the editor.

![](/img/blog/mermaid-progress.gif)
**Figure: Mermaid Diagram editing/Rendering inside the Rich Text Editor**

### Part 2: Parsing and Saving Mermaid Diagrams (In Progress)

The next phase focuses on **parsing and saving** these diagrams. Since TinaCMS uses customized `mdast`, the challenge lies in ensuring the Mermaid syntax is correctly parsed, saved, and reloaded without issues.

### What’s Next?

Next steps include polishing the parsing and saving process and rolling out the final deployment. This will be coming in the 2.3.0 release of `tinacms`. Once that’s done, you will be able to fully integrate, edit, and save Mermaid diagrams within TinaCMS 🦙

In the meantime, feel free to explore the development progress over at https://github.com/tinacms/tinacms/issues/4734


Thank you for your continued support and feedback!

Best,

The TinaCMS Team 🦙
Binary file added public/img/blog/mermaid-progress.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.