markup
Mermaid
markup | Mermaid | |
---|---|---|
9 | 90 | |
5,781 | 3,584 | |
0.2% | 3.2% | |
1.8 | 9.1 | |
about 1 month ago | 5 days ago | |
Ruby | TypeScript | |
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
markup
-
Give your brain time to think and remember
Btw github supports more than just markdown: https://github.com/github/markup#markups
-
Documentation generators and custom syntax highlighting
I'm not sure 4. works for colors/styling, style attributes are stripped: https://github.com/github/markup/issues/119
- Do you think we will see color text in GFM?
-
Hiding front matter block in github markdown
I found this issue, which does not show much traction: https://github.com/github/markup/issues/994
-
Hi DM's, what medium do you use to organise your campaign?
For sharing settings and lore with players, GitHub wiki. Understands Org and several other formats thanks to GitHub Markup, so I can copy in (and trim down) my original notes without much fuss.
- raw-markdown and rendered markdown
-
Include diagrams in your Markdown files with Mermaid
Re: https://github.com/github/markup/issues/533
I’m the main author of KeenWrite (see screenshots), a type of desktop Markdown editor that supports diagrams. It’s encouraging to see that Mermaid diagrams are being supported in GitHub. There are a few drawbacks on the syntax and implications of using MermaidJS.
First, only browser-based SVG renderers can correctly parse Mermaid diagrams. I’ve tested Apache Batik, svgSalamander, resvg, rsvg-convert, svglib, CairoSVG, ConTeXt, and QtSVG. See issue 2485. This implies that typesetting Mermaid diagrams is not currently possible. In effect, by including Mermaid diagrams, many documents will be restricted to web-based output, excluding the possibility of producing PDF documents based on GitHub markdown documents (for the foreseeable future).
Second, there are numerous text-to-diagram facilities available beyond Mermaid. The server at https://kroki.io/ supports Mermaid, PlantUML, Graphviz, byte fields, and many more. While including MermaidJS is a great step forward, supporting Kroki diagrams would allow a much greater variety. (Most diagrams produced in MermaidJS can also be crafted in Graphviz, albeit with less terse syntax.)
Third, see the CommonMark discussion thread referring to a syntax for diagrams. It’s unfortunate that a standard “namespace” concept was not proposed.
Fourth, KeenWrite integrates Kroki. To do so, it uses a variation on the syntax:
``` diagram-mermaid
-
Footnotes now supported in GitHub Markdown
I thought it only rendered files in the repo (match by extension). Does GH also allow asciidoc(tor) syntax in comments and issues?
* Note: Sadly, include is not supported on GH. https://github.com/github/markup/issues/1095
- Compare AsciiDoc and Markdown
Mermaid
- Conquering System Design Diagrams: My Shift to Mermaid.js
- Mermaid Live Editor
- Mermaid Chart, a Markdown-like tool for creating diagrams, raises $7.5M
-
Using Mermaid JS to generate a diagram from Power Automate
Mermaid JS is a tool that lets you create diagrams and charts such as flowcharts, sequence diagrams, Gantt charts using simple text commands. It works by converting your text commands into a graphical representation that you can customize and share. https://mermaid.live/
- FLaNK Stack Weekly 22 January 2024
-
LLMs and Programming in the first days of 2024
I'm not OP, but I just ask GPT to turn code or process or whatever else into a mermaid diagram. Most of the time I don't even need to few-shot prompt it with examples. Then you dump the resulting text into something like https://mermaid.live/ and voilà.
-
Open-source drawing tool – Excalidraw
I like excalidraw for live discussions but if I want to make more detailed or better looking diagrams, I really enjoy these two tools:
- For drag-and-drop/WYSIWYG, I really like DrawIO. They have a web version https://app.diagrams.net/ but I strongly recommend the desktop version https://github.com/jgraph/drawio-desktop/releases/
- For text-as-diagram, I think Mermaid wins this by default since GitHub added markdown support for these: https://mermaid.live/ (This was github's announcement https://github.blog/2022-02-14-include-diagrams-markdown-fil... )
-
I lost a full day's work thanks to Mermaid.
After hours without being able to solve this problem, I decided to make the chart directly in Mermaid's live editor and export it to PNG and SVG. The big problem is that the letters are still too small, the quality of the PNG is very low, and the SVG only works on the web, not with other applications like PowerPoint and Inkscape.
-
Nomnoml
You can export to PNG and other formats in the Mermaid editor https://mermaid.live/
-
Creating mindmaps with ChatGPT
Copy paste code here: https://mermaid.live
What are some alternatives?
org-mode - This is a MIRROR only, do not send PR.
plantuml - Generate diagrams from textual description
gitlab-foss
kroki - Creates diagrams from textual descriptions!
libasciidoc - A Golang library for processing Asciidoc files.
obsidian-releases - Community plugins list, theme list, and releases of Obsidian.
commonmark-spec - CommonMark spec, with reference implementations in C and JavaScript
golang-nextjs-portable - Go program with embedded Next.js app.
aasvg - Turn ASCII art into SVG
DrawThe.Net - drawthe.net draws network diagrams dynamically from a text file describing the placement, layout and icons. Given a yaml file describing the hierarchy of the network and it's connections, a resulting diagram will be created.
cmark-gfm - GitHub's fork of cmark, a CommonMark parsing and rendering library and program in C
wavedrom - :ocean: Digital timing diagram rendering engine