Show HN: Podlite - a lightweight markup language for organizing knowledge(podlite.org)
podlite.org
Show HN: Podlite - a lightweight markup language for organizing knowledge
https://podlite.org/2024/4/23/1/podlite-specification-v1-0-released
48 comments
It took me a few clicks but here's an example Podlite document for anyone who likes to jump straight into examples: https://github.com/podlite/podlite-specs/blob/main/Specifica...
This introductory blog post from February is useful too: https://podlite.org/2024/2/21/1/introducing-podlite-a-lightw...
This introductory blog post from February is useful too: https://podlite.org/2024/2/21/1/introducing-podlite-a-lightw...
just jump in the playground: https://pod6.in/
While I think this is worth exploring, at a certain point you end up doing so much that you could just write raw HTML, and then you'd have the advantage of being able to display it directly in the browser and using Javascript's powerful querying features.
Good question!
To meet modern requirements and make documents dynamic, we need a flexible API and integration with contemporary frameworks. Simple HTML just isn't up to the task. Although this was the approach during the early implementation (https://github.com/zag/js-pod6), it turned out to be a dead end.
thank you
To meet modern requirements and make documents dynamic, we need a flexible API and integration with contemporary frameworks. Simple HTML just isn't up to the task. Although this was the approach during the early implementation (https://github.com/zag/js-pod6), it turned out to be a dead end.
thank you
Please, anytime you try to imitate parts of org-mode, consider org-mode, markup and abilities.
I had all kinds of plans for my knowledge management for over a decade. Then I started using org-roam and now the activation energy to consider anything else is so high that I'm stuck in a local minimum.
What do you mean ?
I had the idea that handwriting, an infinite canvas and cross linking between ideas were going to be a big part of my external knowledge base. So I learnt a lot of technical skills that would allow me to put something like that together. Then right around the time I got an eink tablet and thought I'd start making something, I started using org-roam and it seems more than enough to contain all the information I tend to want to record. If I really want to handwrite or sketch something, I'll just do it on paper and snap a picture, crop it and paste it in Emacs (I have a script that copies it into a subdirectory) and the whole thing lives in a git repo.
You might like artist mode (while personally I use it only to "fill" pdf non-fillable form with TiKz) :-)
Nice, will have a look
To quickly locate, via artist-mode the spot to be filled in a pdf, view via pdf-tools https://github.com/Nidish96/cart.el as dummy handwritten fonts I like:
\usepackage{pbsi} % for most text except all-caps
\usepackage{fontspec} % for all-caps, require XeLaTeX o LuaLaTeX
\usepackage{pifont} % for check marks
\usepackage{xcolor} % for a dummy ink color
\newcommand{\blue}[1]{\textcolor{blue}{#1}} % as a handy wrapper
% block for page 1, repeat the block for 2, ...
\begin{tikzpicture}[remember picture,overlay]
\node at (current page.center) {\includegraphics[page=1]{ToBeFilledPDF}};
\begin{scope}[shift={(current page.south west)},every node/.style={anchor=base west}]
\node at (50mm,237mm) {{\blue{\bsifamily normal text}}};
\node at (29mm,170mm) {{\blue{\fontsize{12}{13}\selectfont\bsifamily scale text size as needed}}};
\node at (62mm,199.7mm) {{\blue{\ding{51}}}}; % a checkmark
\node at (135mm,24mm) {\includegraphics[scale=1]{signature.png}};
\node at (1mm,2mm) {{\blue{\fontspec{QTChanceryType}\bfseries ALL CAPS}}};
\end{scope}
\end{tikzpicture}
also if you find yourself inventing a new complex syntax for yet another markup language... consider doing something else instead
Please put concrete examples right at the top of the page you're publicizing!
The specification for the Podlite markup language is written using Podlite markup itself.
https://github.com/podlite/podlite-specs/blob/main/Specifica...
Also online playground is available here: https://pod6.in/
Thanks for your interest in Podlite! with best, Alex
https://github.com/podlite/podlite-specs/blob/main/Specifica...
Also online playground is available here: https://pod6.in/
Thanks for your interest in Podlite! with best, Alex
That playground is cool. I wonder if there are any 2-way playgrounds where the right side is also editable using a Word / Google Docs style interface (and the changes are reflected in the code-style interface on the left). I've always wanted something like that for teaching non-technical people the basics of Markdown. Bonus points if it's collaborative.
This is a wonderful and highly sought-after idea. However, it requires significant resources, so we will definitely come back to it and implement it. Thank you
What's the main advantage over AsciiDoc?
Although it's already on your roadmap, but it definitely needs more complex examples. Fiddled around a bit with links to same-doc references. Got it to work, but took a while.
Although it's already on your roadmap, but it definitely needs more complex examples. Fiddled around a bit with links to same-doc references. Got it to work, but took a while.
I'm still upset that Markdown ended up getting all the mindshare. AsciiDoc is so much nicer.
I'm happy that something at all got all the mindshare. Otherwise we'd still each be using something different.
Markdown is perfectly usable.
Markdown is perfectly usable.
AsciiDoc is much nicer, but has the unfortunate flaw of having basically one implementation and it's in Ruby (the JS one is just transpiled, the Java one runs on JRuby, not sure about Go and Haskell).
They don't even have a Python library, which basically guarantees that AsciiDoc won't be taught in colleges.
I like AsciiDoc, but not nearly enough to mess around with installing Ruby and Gems and then having to do the same for anyone else at work that needs to build the docs for whatever reason.
Ruby is basically a non-starter for me in general. Dependency management and interpreter versioning is a pain in the ass for interpreted languages, so I'd rather have as few as possible on my system. I've already got Perl and Python installed by default, I'd rather not add a third.
They don't even have a Python library, which basically guarantees that AsciiDoc won't be taught in colleges.
I like AsciiDoc, but not nearly enough to mess around with installing Ruby and Gems and then having to do the same for anyone else at work that needs to build the docs for whatever reason.
Ruby is basically a non-starter for me in general. Dependency management and interpreter versioning is a pain in the ass for interpreted languages, so I'd rather have as few as possible on my system. I've already got Perl and Python installed by default, I'd rather not add a third.
Looks like they’re making progress on that since the Eclipse Foundation took over AsciiDoc. There are now Golang and Haskell processors
https://gitlab.eclipse.org/eclipse-wg/asciidoc-wg/asciidoc.o...
https://gitlab.eclipse.org/eclipse-wg/asciidoc-wg/asciidoc.o...
Ooh, that’s exciting news. I would love to use acidic, I’ve just been waiting for them to give me a reason.
It’s a long shot, but if GitHub/GitLab added render support for AsciiDoc my life would be complete.
Regardless, it’s impressive and awesome progress.
It’s a long shot, but if GitHub/GitLab added render support for AsciiDoc my life would be complete.
Regardless, it’s impressive and awesome progress.
I'm still upset that Markdown ended up getting all the mindshare and doesn’t evolve. All the fragmentation through different markdown flavors doesn’t help.
Evolution in the biological world usually looks a lot like fragmentation, at least in the short term.
You are right. It would be interesting to compare evolution from a computer scientific and biological point of view. To find out if they are similar…
I believe that natural evolution makes it easier to let the bad branches die out.
I believe that natural evolution makes it easier to let the bad branches die out.
We need a specification for the forced extinction of markup languages that fail to gain traction.
The original core markdown being privately owned and frozen doomed it to having a politically funny future.
Isn't it the way perl scripts write their documentation? I don't know what makes it good for personal knowledge systems from reading the introduction
Perl's POD, yes. But you're right! The spec authors are Perl folx, and this is clearly derivative. What's kind of interesting is that POD stands for "Plain Old Documentation" and then there's a "lite" version of it... so "lite-r Plain Old Documentation" --- I don't see a clear summary of the differences, though.
Reading through the source for the specifications was interesitng.
There is a lot of good stuff here, but there is so much to learn
but I dont see enough benefits to push me to learn it when I
already have Latex,Markdown and straight HTML in my toolbox.
I would like to be proven wrong though.
I would like to be proven wrong though.
Podlite indeed looks promising, especially with its extensibility and support for Markdown. I agree that if a markup language gets too complex, using raw HTML might be more advantageous. However, I think the strength of Podlite lies in its universality and flexibility, allowing it to adapt to various project requirements.
I'm particularly interested in the extensibility of Podlite. This feature allows the language's functionality to be expanded according to the specific needs of a project, which could be a huge plus in many cases. I look forward to seeing how Podlite evolves.
As for using raw HTML and JavaScript, while they indeed provide powerful querying features, Podlite might be simpler and more intuitive for those who are not familiar with these technologies. I think that's another strength of Podlite.
All in all, I think Podlite is a project worth watching. I'll keep an eye on its progress and look forward to seeing what changes it can bring in the future. Thanks for sharing this project!
I'm particularly interested in the extensibility of Podlite. This feature allows the language's functionality to be expanded according to the specific needs of a project, which could be a huge plus in many cases. I look forward to seeing how Podlite evolves.
As for using raw HTML and JavaScript, while they indeed provide powerful querying features, Podlite might be simpler and more intuitive for those who are not familiar with these technologies. I think that's another strength of Podlite.
All in all, I think Podlite is a project worth watching. I'll keep an eye on its progress and look forward to seeing what changes it can bring in the future. Thanks for sharing this project!
Interesting approach.
I would love to have a notation to get a various ways of representing of intellectual tasks into a single document. A real killer feature in my eyes would be if a kind of umbrella markup language would support a convenient two-way binding for creating and manipulating notations, so for example that diagrams could not only be rendered in a desktop app, but also be manipulated with the markup being automatically being updated. I guess the problem is that light-weight implies too little structure to make such a thing easy to implement...
I would love to have a notation to get a various ways of representing of intellectual tasks into a single document. A real killer feature in my eyes would be if a kind of umbrella markup language would support a convenient two-way binding for creating and manipulating notations, so for example that diagrams could not only be rendered in a desktop app, but also be manipulated with the markup being automatically being updated. I guess the problem is that light-weight implies too little structure to make such a thing easy to implement...
I think you've lost the point of Markdown: it's readable as raw text.
I was excited that this was an extension of markdown but now I that see it I react with horror: markdown is not a programming language. This looks rather like a programming language.
I was excited that this was an extension of markdown but now I that see it I react with horror: markdown is not a programming language. This looks rather like a programming language.
Wow. This is so good. For reference:
It is 4 times smaller than HTML.
It is 29.5 times smaller than PDF.
It has a really good structure and is more readable than Markdown (sometimes).
Looks nice, I have a couple of questions:
Does this use a single pass for the parser? Is there an EBNF spec? What sort of diagrams does it support?
Thanks
Does this use a single pass for the parser? Is there an EBNF spec? What sort of diagrams does it support?
Thanks
The existing typescript implemetation builds a complete AST (Abstract Syntax Tree), over which middlewares are run in several passes. Yes, there are multiple passes over the tree. This is necessary, among other things, to build a table of contents (TOC).
thank you
Might not work for my use case then. djot is single-pass so dovetails better with forth-style languages.
I do like the blocks and mistake marking though :)
Interesting. Have you been using djot for anything substantial, like technical/academic publishing, large projects like entire books, or similar? How does it fare and what is your toolchain? Thanks in advance!
I'm trying to use it as part of a new forth-style language, hence the need for single-pass.
I've found it as easy to use as markdown, but more regular ie. Well defined, which suits a language spec.
The key parts for me are reference links for execution-thread documentation and ``` blocks to program literally, (and separate/scope comments // from documentation """)
The toolchain as such is just part of the language- the compiler needs to parse djot. I'm not fully there though.
I've found it as easy to use as markdown, but more regular ie. Well defined, which suits a language spec.
The key parts for me are reference links for execution-thread documentation and ``` blocks to program literally, (and separate/scope comments // from documentation """)
The toolchain as such is just part of the language- the compiler needs to parse djot. I'm not fully there though.
This is a specification, it does not declare how implementations work.
At the moment only typescript implementation exists and here is PEG grammars from it: https://github.com/podlite/podlite/blob/main/packages/podlit...
At the moment it supports Mermaid diagrams:
https://pod6.in/#p=%3Dbegin+Mermaid++%3Acaption%28%27Caption...
At the moment only typescript implementation exists and here is PEG grammars from it: https://github.com/podlite/podlite/blob/main/packages/podlit...
At the moment it supports Mermaid diagrams:
https://pod6.in/#p=%3Dbegin+Mermaid++%3Acaption%28%27Caption...
Hey, I'm Lee! I like this, nice work! :)
Ouch. IMHO the reason markdown became so popular is because how simple it is, how well the syntax generally stays out of the way of the content, and its almost entire lack of mixing formatting with document structure.
This is VERY heavy, and VERY invasive. The entire lack of opinion in "use whatever markup you like as long as its wrapped in our markup" seems like an extra awful complication. I'd be curious to hear about what concrete problems the authors of this spec were trying to solve and why they went so far.
This is VERY heavy, and VERY invasive. The entire lack of opinion in "use whatever markup you like as long as its wrapped in our markup" seems like an extra awful complication. I'd be curious to hear about what concrete problems the authors of this spec were trying to solve and why they went so far.
I thought the same thing when I saw the example page. Its closer to html than markdown.
[deleted]
Damian Conway… a name to conjure with.
What are the advantages of the Podlite design?
What are the advantages of the Podlite design?
It's extensible and not tied to any specific programming language, allowing for constructs like this ( mix chunks of markdown and build TOC ):
---
=toc head1, head2, head3
=begin markdown
https://pod6.in/#p=%3Dtoc+head1%2C+head2%2C+head3%0A%0A%3Dbe...
---
=toc head1, head2, head3
=begin markdown
# header from markdown
## second level
=end markdown
=head1 This is header from Podlite https://pod6.in/#p=%3Dtoc+head1%2C+head2%2C+head3%0A%0A%3Dbe...
That's an interesting feature. What is its advantage, i.e. how and when is it useful?
I agree with you on this. It's a cool feature.
What I find most interesting is that there’s no need to choose between Podlite and Markdown; you can use both and switch between them as needed.
I think Podlite could be really useful in document management systems and electronic publishing. But... let's see what practical uses Podlite will find.
thank you
What I find most interesting is that there’s no need to choose between Podlite and Markdown; you can use both and switch between them as needed.
I think Podlite could be really useful in document management systems and electronic publishing. But... let's see what practical uses Podlite will find.
thank you
In addition, the support for Markdown markup as a standard block adds convenience and allows for the use of familiar syntax for text formatting
It's perfect for documentation, educational materials, blogging, and much more for organizing knowledge.
One of the key features of Podlite is its extensibility. This allows for defining unique and domain-specific blocks and expanding the language's functionality according to the requirements of your project.
The Podlite specification is published under the Artistic license 2.0.
Site: https://podlite.org Thank You!