TLDR; Okular Feature Request - asciidoc live preview for Okular and Ghostwriter
Hi there KDE forums.
I have a Feature Request for Okular (and possibly for Ghostwriter ):
asciidoc LIVE PREVIEW
I love the way I can use Okular as a live previewer for markdown documents.
I would love to be able to do the same for asciidoc documents, as it is a similar but generally superior format.
Also unlike markdown: it also has a single standard as a language, rather than multiple forks all over the place, and so is easier to maintain.
So I am trying to do more document writing this way.
Also, I love Ghostwriter markdown editor.
Is it possible for KDE developers to adapt this so it can also be an editor for and previewer for asciidoc?
If so, that would be amazing.
Anyway, just thought I would put these wishes out there for consideration.
The content of this open source project is received and distributed under the license(s) listed above. Some source code and binaries may be distributed under different terms. Specific license information is provided in file headers and in NOT
An EPL-licensed program may be used, modified, copied and redistributed freely.
The source code of derived (modified) versions must be disclosed under the same license.
Proprietary software can include an EPL-licensed program, as long as it is not a derivative of that program. For example, it can use it as a library.
The EPL is approved by the Open Source Initiative and recognized as free by the Free Software Foundation, but is not compatible with GPL-2.0.
So there’s no legal obstacle to using asciidoc in KDE.
Currently, there is no official approved specification of Asciidoc, so this language is defined by its implementation Asciidoctor
I think the addition of Asciidoctor would be interesting.
Especially since Ghostwriter’s markdown to pdf export is partially broken (wkhtmltopdf is no longer maintained since January 2, 2023).
@skyfishgoo,
Thanks. Good point, I had not considered the license, but according to wikipedia, it is under an MIT license, which is good news, I would think.
There are several reasons why I have just begun to start to use it.
As I understand it:
Markdown is not a common standard. There are many implementations of it, and so not all interpreters / converters can cater to all the many implementations.
There is an attempt to standardize and unify by commonmark, but this is far from universal, and there are many competing “standards”.
There are a large number of articles online covering all the reasons why asciidoc is a superior format to markdown
Here is one that mentions a few
search for
git-tower com blog asciidoc-quick-guide
There is some information there.
I will try to find the other articles and reviews on this topic I have read later. But suffice to say, I am convinced.
@olivierbelleux
Great contribution and information, thank you! I don’t know what else to say, other than “well put!” (:
This was another excellent article I read on the topic of why in most circumstances one should switch to asciidoc (or sphinx, which I don’t know much about yet, but shall explore at some point) from markdown, for serious and lengthy documentation, books, PKBs / personal wikis, larger scale projects with multiple contributors etc.
It seems I cannot post links here so you may have to search for these terms in the URL.
Why You Shouldn’t Use “Markdown” for Documentation
ericholscher com /blog/2016/mar/15/ dont-use-markdown-for-technical-docs
etc… See the article for his arguments.
Some of the list of “flavours” of markdown
github com commonmark / commonmark-spec /wiki/Markdown-Flavors