kroki
mdBook
Our great sponsors
kroki | mdBook | |
---|---|---|
49 | 100 | |
2,669 | 16,669 | |
4.3% | 2.8% | |
8.8 | 8.6 | |
6 days ago | 12 days ago | |
JavaScript | Rust | |
MIT License | Mozilla Public License 2.0 |
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.
kroki
-
WireViz: Easily document cables and wiring harnesses
Your wish showing up in the face of a submission just 14 days ago and then another 29 days ago must be indicative of why there are so many dupes all the time: https://news.ycombinator.com/from?site=kroki.io
You can feel free to submit the GH repo, as that one doesn't seem to have been submitted before https://github.com/yuzutech/kroki
-
D2 Playground
Pikchr https://pikchr.org/home/pikchrshow is the other general purpose one and older than d2. It is "Source-Code License: 0-clause BSD" as it says on the page.
Someone made it into wasm and put playground for pikchr here https://www.jakethaw.com/pikchr_webassembly_demo/
Can also try pikchr online here on https://kroki.io/#try which is hosting many other text to diagram tools as well.
-
Mermaid Chart, a Markdown-like tool for creating diagrams, raises $7.5M
I use mermaid.js heavily, but plug for Kroki:
https://kroki.io/
“Kroki provides a unified API with support for BlockDiag (BlockDiag, SeqDiag, ActDiag, NwDiag, PacketDiag, RackDiag), BPMN, Bytefield, C4 (with PlantUML), D2, DBML, Ditaa, Erd, Excalidraw, GraphViz, Mermaid, Nomnoml, Pikchr, PlantUML, Structurizr, SvgBob, Symbolator, TikZ, UMLet, Vega, Vega-Lite, WaveDrom, WireViz... and more to come!”
- Kroki: A unified API to create any kind of diagram from text
- Kroki – Creates diagrams from textual descriptions
- How to draw beautiful software architecture diagrams
-
Nomnoml
If you don't mind my asking, what aspects of "acceptable layout" is usually the first to get busted?
I'm extremely excited about using WireViz[1] to automate wiring harness diagram creation, and if I can, I'd like to know the speedbumps before I hit them. I'm thinkin generous linking between diagrams will be one path.
[1] Project:: https://github.com/wireviz/WireViz SandboxP:: https://kroki.io/#try [select Diagram>WireViz]
-
LaTeX for publishing tabletop role-playing games
The SVG output is embedded into the PDF file.
https://kroki.io/examples.html#mind-map
Kroki has other text-based formats for flow charts, Gantt charts, UML diagrams, packet diagrams, network diagrams, word clouds, etc.
-
Documentation as Code for Cloud Using PlantUML
My cross-platform desktop text editor, KeenWrite, allows users to define variables in an external YAML file. The editor calls out to Kroki[1] to convert text-based diagrams to SVG. The diagrams can reference variables and are rendered using EchoSVG[2].
KeenWrite[3] can produce PDF documentation from Markdown documents that has PlantUML diagrams with elements stored in an external, machine-readable file. Here are screenshots showing variables on the left, diagram text in the middle, and a real-time render on the right:
* https://raw.githubusercontent.com/DaveJarvis/KeenWrite/main/...
* https://raw.githubusercontent.com/DaveJarvis/KeenWrite/main/...
KeenWrite supports all diagrams offered by Kroki, which includes "diagram-plantuml".
[1]: https://kroki.io/
[2]: https://github.com/css4j/echosvg/
[3]: https://github.com/DaveJarvis/keenwrite
- Pikchr: A PIC-like markup language for diagrams in technical documentation
mdBook
- Doks – Build a Docs Site
-
Ask HN: How do you organize software documentation at work?
I'm responsible for a number of Java products. I try to provide high-quality Javadoc for all public library interfaces, library user's guides where appropriate, and development guides for applications. The latter two take the form of MDBook documents (https://rust-lang.github.io/mdBook/), with the document source living in the GitHub repo so that it's tied to the particular software release in a natural way.
-
Outline: Self hostable, realtime, Markdown compatible knowledge base
My org has used mdBook: https://rust-lang.github.io/mdBook/ (That link is itself a rendered mdBook, so that'll give you an idea of the feature set.)
(While it's definitely a Rust "thing", if you just have a set of .md files, all you need is a "SUMMARY.md" (which contains the ToC) and a small config file; i.e., you don't have to have any Rust code to use it, and it works fine without. We document a large, mostly non-Rust codebase with it.)
-
Ask HN: Best tools for self-authoring books in 2023?
If you want the lowest friction, open source, easily extensible Markdown to Web, Kindle, PDF, etc. tool, highly recommend mdBook: https://github.com/rust-lang/mdBook it’s written in Rust, but you don’t have to know any Rust to use it. And then wing is all CSS; for which there are many good (free) themes.
- Early performance results from the prototype CHERI ARM Morello microarchitecture
- FLaNK Stack for 4th of July
- MdBook – A command line tool to create books with Markdown
- MdBook Create book from Markdown files. Like Gitbook but implemented in Rust
-
MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
Interesting enough there seems to be an open PR for that: https://github.com/rust-lang/mdBook/pull/1918
What are some alternatives?
Mermaid - Edit, preview and share mermaid charts/diagrams. New implementation of the live editor.
gitbook - The open source frontend for GitBook doc sites
plantuml-syntax - vim syntax file for plantuml
MkDocs - Project documentation with Markdown.
plantuml - Generate diagrams from textual description
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
mermaid - Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown
bookdown - Authoring Books and Technical Documents with R Markdown
venn.nvim - Draw ASCII diagrams in Neovim
obsidian-releases - Community plugins list, theme list, and releases of Obsidian.
Zettlr - Your One-Stop Publication Workbench
Docusaurus - Easy to maintain open source documentation websites.