I wrote up some details, that are maybe useful and can boost Logseq markup features.
Currently Admonitions are not well supported during export and a hint by @Ramses motivated me to put my suggestions from my original answer to an already archived post into a new topic in the Feedback category as a Feature Requests .
TL;DR;
Logseq could aquire MyST parser Markdown technology to improve feature rich and standardized admonitions and more – including existing converter technology. This could save a lot of time and sweat.
Motivation
I want to add some scope why I am so after preserving proper admonition markup, because they add so
- much better visual understanding and
- differentiation to written notes and
- almost every software documentation makes use of these metaphors
that (I guess) came from Org-Mode to Logseq.
I was wondering how I could add more custom admonition types to Logseq, but never found the time to followup that effort.
Why Copy Paste of Admonitions (and every markup detail) is important and how to do that
It is a kind of bug that simple copy pasting of blocks does not work in Logseq, but in the Markdown source. (One major pitfall of these workarounds is accidential improper preservation of block IDs and UUIDs on duplication or move and handling the reindexing).
Solution: At least offer to copy the full plain Markdown of nested blocks from the source file using a Keyboard-Shortcut Qualifier.
Any chance to add that feature to current Logseq Desktop at least as an PlugIn Extension?
Technical details:
It would help to have an additional! special logseq clipboard flavor to allow seamless copy / pasting.
Background why Admonitions matter for us
I am strongly involved in our internal knowledge management documentation team since decades. We are heavy internal users of Logseq for some years and use our internal workflows to colaborate on docs. We use Logseq as well to prepare content for later transfer into Sphinx-doc based documentations. We used reStructuredText for that for years because of the rich markup. Sphinx-doc could use Markdown syntax from some point on, but the limitations of Markdown missed to use all the finetuning helpful to write proper documents.
How to deal with admonitions in Markdown
You may know Sphinx generated docs from all kind of projects. Especially the autogenerate features are nice. There are other systems outside of the Python origin Sphinx-doc came from , that were influenced by Sphinx-doc.
Readthedocs.io was a Sphinx-doc based public saas effort to improve OpenSource Software docs and became very popular and contributed a nice theme for Sphinx-doc, you may see today very often.
Then some efforts were made to close the limitation gap with Markdown and Sphinx that itself enhanced reStructuredText with directives coming from the python docutils.
The Myst Parser adds nice Admonitions and more to Markdown
The Myst-Parser allowed two things:
- Have a lossless translation of existing docs (reStructuredText) to the more popular Markdown with some enhancements to be feature complete.
- Make it easier to invite new authors, because ReST was a niche related to Markdown becoming a mainstream markup standard. While standard is a bit misleading.
Semi WYSIWYG
As we see with Logseq a semi WYSIWYG approach to write in markdown but instantly translating blocks into Richtext/HTML for display became a well known approach.
For having some kind of roundtripping in Logseq we still need to work on the Markdown source in the blocks and, if nested, to some extends in the plain Markdown files (at least in our workflows).
No Roudtripping Example: Others like the Notes Editor in Zotero allows writing in Markdown and pasting RichText, but then the Markdown is not exposed anymore (Except some KungFu tricks).
Conclusion
Having Logseq as an Authoring Tool for notes and all kind of content has improved my productivity over the last years a lot.
Roundtripping of content (moving in and out) ist important for the long term Content Management Lifecycle thinking in decades and ages, something we seriously miss in our digital world.
Loosing important markup or content by accident is a nogo for a long term Content Management Lifecycle. It is like listening to an ancient speech synthesizer not capable of proper intonation.