TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

Pikchr – PIC-like markup language for diagrams in technical documentation

38 pointsby leonimover 3 years ago

7 comments

paulsmithover 3 years ago
If it&#x27;s not immediately apparent, Pikchr is by SQLite creator D. Richard Hipp, and is how SQLite&#x27;s syntax diagrams are generated on its website.<p>It&#x27;s a great little diagram language that&#x27;s quite capable, and I think of it like a modern web upgrade to Brian Kernighan&#x27;s PIC.
fabiospampinatoover 3 years ago
Pikchr is awesome! I&#x27;ll just mention that the Markdown-based note-taking app I&#x27;m working on as far as I know is the only app on the planet that can syntax-highlight Pikchr code: <a href="https:&#x2F;&#x2F;github.com&#x2F;notable&#x2F;notable-insiders&#x2F;releases&#x2F;tag&#x2F;v1.9.0-beta.4" rel="nofollow">https:&#x2F;&#x2F;github.com&#x2F;notable&#x2F;notable-insiders&#x2F;releases&#x2F;tag&#x2F;v1....</a>
electrolyover 3 years ago
Pikchr is really great. The syntax looks strange at first, but the learning curve is actually low. Within 5 minutes of looking at the pikchr source of some SQLite diagrams, you&#x27;ll get it. I use it to produce railroad syntax diagrams in the same style as the ones in the SQLite docs. I don&#x27;t use the Markdown integration; I just generate SVGs using PikchrShow[0] and treat them as images in my HTML-based docs.<p>[0] <a href="https:&#x2F;&#x2F;pikchr.org&#x2F;home&#x2F;pikchrshow" rel="nofollow">https:&#x2F;&#x2F;pikchr.org&#x2F;home&#x2F;pikchrshow</a>
评论 #29914263 未加载
danshearerover 3 years ago
I have used both Pikchr and several of the Mediawiki extensions for diagrams (the most recently-maintained of which is <a href="https:&#x2F;&#x2F;www.mediawiki.org&#x2F;wiki&#x2F;Extension:Flex_Diagrams" rel="nofollow">https:&#x2F;&#x2F;www.mediawiki.org&#x2F;wiki&#x2F;Extension:Flex_Diagrams</a> )<p>Here is my earliest Pikchr effort: <a href="https:&#x2F;&#x2F;lumosql.org&#x2F;src&#x2F;not-forking" rel="nofollow">https:&#x2F;&#x2F;lumosql.org&#x2F;src&#x2F;not-forking</a> (click to see source.)<p>Pikchr diagrams are crisp and precise with zero configuration. Mermaid diagrams are difficult to make render as nicely as the screenshots show (<a href="https:&#x2F;&#x2F;mermaid-js.github.io" rel="nofollow">https:&#x2F;&#x2F;mermaid-js.github.io</a> ) and easier to confuse with ambiguous syntax.<p>With the addition of 5 lines Lua, Pandoc now handles Pikchr in Markdown documents: <a href="https:&#x2F;&#x2F;groups.google.com&#x2F;g&#x2F;pandoc-discuss&#x2F;c&#x2F;zZSspnHHsg0&#x2F;m&#x2F;mxgoOHm0AQAJ" rel="nofollow">https:&#x2F;&#x2F;groups.google.com&#x2F;g&#x2F;pandoc-discuss&#x2F;c&#x2F;zZSspnHHsg0&#x2F;m&#x2F;m...</a>
OJFordover 3 years ago
&gt; Pikchr is designed to be embedded in fenced code blocks of Markdown<p>Odd choice, usually that&#x27;s how you&#x27;d show the (possibly syntax-highlighted) code as-is, not execute&#x2F;render it in situ.<p>E.g. what if I want a document that says &#x27;this pikchr code generates this&#x27;? I&#x27;d expect to write something like:<p><pre><code> ```pikchr arrow 200% &quot;whatever&quot; ``` renders: $pikchr arrow 200% &quot;whatever&quot; $ </code></pre> (Or some other syntax) not the code block twice, once with some kind of escaping.
评论 #29914205 未加载
评论 #29911960 未加载
srvmshrover 3 years ago
I wasn&#x27;t aware of this &amp; looks like worth learning. I was looking ahead to learn Penrose (<a href="https:&#x2F;&#x2F;penrose.ink&#x2F;" rel="nofollow">https:&#x2F;&#x2F;penrose.ink&#x2F;</a>) for making diagrams in my notes.
otherflavorsover 3 years ago
contrary to pikchr documentation, troff is not obsolete
评论 #29914225 未加载