plugin:markdowku
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:markdowku [2017-02-19 18:50] – Formatting 2a02:168:4638:a:f1de:b72a:604e:16e0 | plugin:markdowku [2024-03-08 14:30] (current) – [markdowku Plugin] report bugs broken link beco | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== markdowku Plugin ====== | + | ===== markdowku Plugin ====== |
---- plugin ---- | ---- plugin ---- | ||
description: | description: | ||
- | author | + | author |
- | email : gnrp@komkon2.de | + | email : raphael.wimmer@ur.de |
type : Syntax | type : Syntax | ||
- | lastupdate : 2017-02-19 | + | lastupdate : 2021-12-04 |
- | compatible : Adora Belle, Weatherwax, Binky, Ponder Stibbons, Elenor of Tsort | + | compatible : !Greebo, Hogfather, Igor |
depends | depends | ||
conflicts | conflicts | ||
similar | similar | ||
- | tags : formatting, markup_language | + | tags : formatting, markdown, markup_language |
- | downloadurl: | + | downloadurl: |
- | bugtracker : https:// | + | bugtracker : https:// |
- | sourcerepo : https:// | + | sourcerepo : https:// |
- | donationurl: | + | |
---- | ---- | ||
===== Installation ===== | ===== Installation ===== | ||
- | Install | + | Search and install |
+ | |||
+ | ==== Greebo ==== | ||
+ | The version linked above is only compatible with DokuWiki versions Hogfather and later. | ||
+ | If you are still running **Greebo**, please use [[https:// | ||
===== Examples/ | ===== Examples/ | ||
- | This plugin will go before the overlapping DokuWiki syntax definitions and overrule them with Markdown specifications. | + | This plugin will go before the overlapping DokuWiki syntax definitions and overrule them with Markdown |
+ | specifications. | ||
For patterns that are not part of Markdown, you can still use DokuWiki, e.g. you're still able to use DokuWiki tables. | For patterns that are not part of Markdown, you can still use DokuWiki, e.g. you're still able to use DokuWiki tables. | ||
Line 40: | Line 45: | ||
==== Known incompatibilities ==== | ==== Known incompatibilities ==== | ||
- | Due to the inner working of Markdown and DokuWiki, there are things which currently cannot be done with this plugin. I am working on getting this fixed. If you want to help, feel free to contact me (gnrp) in IRC. | + | Due to the inner working of Markdown and DokuWiki, there are things which currently cannot be done with this plugin. |
All in all, this plugin is complete. Just when it comes to nesting things, i.e. putting things into each other, this plugin doesn' | All in all, this plugin is complete. Just when it comes to nesting things, i.e. putting things into each other, this plugin doesn' | ||
Line 59: | Line 64: | ||
* codespans with more than five backticks (most probably never used) | * codespans with more than five backticks (most probably never used) | ||
* using underscores to make text bold. Double underline is already used by DokuWiki for underlining text (Markdown can't do that), and I think it's better to have the option for underlining. In general notation, you also rather use underscores for underlining than making text bold. | * using underscores to make text bold. Double underline is already used by DokuWiki for underlining text (Markdown can't do that), and I think it's better to have the option for underlining. In general notation, you also rather use underscores for underlining than making text bold. | ||
+ | * conflict with [[https:// | ||
+ | |||
+ | === Why no nested content in lists? === | ||
+ | |||
+ | From [[https:// | ||
+ | |||
+ | The reason behind these incompatibilities are conceptual differences between Markdown' | ||
+ | |||
+ | Here is an example for this: | ||
+ | |||
+ | > # Blabla | ||
+ | > Blabla | ||
+ | |||
+ | Markdown would see that there' | ||
+ | |||
+ | # Blabla | ||
+ | Blabla | ||
+ | |||
+ | and finally produce a blockquote with a headline in it. | ||
+ | |||
+ | Dokuwiki, on the other hand, uses a lexer you can pass tokens (regexes) to be matched. Visually spoken this means that Dokuwiki parses text only sequentially, | ||
===== Development ===== | ===== Development ===== | ||
- | === Change Log === | ||
- | **Please note that this plugin is not actively developed anymore!** | + | === Version History === |
- | You can find the whole release history on [[http:// | + | **Please note that this plugin is not actively developed at the moment.!** |
+ | |||
+ | Markdowku was initially developed by Julian Fagir. | ||
+ | Raphael Wimmer just made the plugin | ||
+ | Contributions welcome. | ||
+ | |||
+ | ** Seems to work on Jack Jackrum release (as of 2023-07-21). An extra newline in between bullet points is all I note that is finicky compared to normal markdown (where lines can be right after one another and render proper markdown.) | ||
- | **Last update: 2017-02-19**: | ||
=== Bugs/Issues === | === Bugs/Issues === | ||
- | There is a [[https:// | + | Please [[https:// |
+ | |||
+ | There are still some issues in the [[https:// | ||
=== ToDo/Wish List === | === ToDo/Wish List === | ||
Line 78: | Line 110: | ||
This plugin is not complete yet. Incompatibilities are listed above at [[#Known incompatibilities]]. | This plugin is not complete yet. Incompatibilities are listed above at [[#Known incompatibilities]]. | ||
- | In the end, I want to extend this plugin to be able to handle different markdown flavours (esp. Github), with a switch in the configuration to choose between those all. | + | Suggestions by the initial author: |
- | A switch like < | + | * In the end, I want to extend this plugin to be able to handle different markdown flavours (esp. Github), with a switch in the configuration to choose between those all. |
+ | * A switch like < | ||
+ | * The plugin editor does not work together with markdown. Either have the possibility to disable it, or even better, make it work with Markdown (Celano 13-08-08, reformatted by gnrp 13-09-23) | ||
- | The plugin editor does not work together with markdown. Either have the possibility to disable it, or even better, make it work with Markdown | + | Further suggestions |
- | + | * Html doesn’t work but html is correct markdown and really useful for things markdown can’t do. Even the %%< | |
- | The plugin seem useful as we write in markdown but eventually need to use some DokuWiki syntax. I have to say that the wiki display markdown files created elsewhere by peoples using markdown editor | + | |
- | + | ||
- | * Html doesn’t work but html is correct markdown and really useful for things markdown can’t do. Even the %%< | + | |
* Second problem is that we use a lot the footnote syntax of markdown extra (a footnote syntax %%[^1]%% which become near a standard in markdown tools) [[https:// | * Second problem is that we use a lot the footnote syntax of markdown extra (a footnote syntax %%[^1]%% which become near a standard in markdown tools) [[https:// | ||
* Reference-style links from classic markdown doesn’t works. [[http:// | * Reference-style links from classic markdown doesn’t works. [[http:// | ||
- | (dinobib 15-05-25) | + | * It would be nice if Commonmark would be supported! |
===== FAQ ===== | ===== FAQ ===== | ||
Line 95: | Line 127: | ||
=== There are already two Markdown plugins, why do you write a third one? === | === There are already two Markdown plugins, why do you write a third one? === | ||
- | The prior two plugins ([[markdown]], | + | Prior plugins ([[mdpage]]((last update: 2021)), |
This plugin adds Markdown to the DokuWiki syntax, i.e. it still uses DokuWiki definitions for lists, headers, etc. Thus, markdowku enables you to use internal links, mix Markdown with other plugins and other syntaxes and have clean section headers and media embedding. | This plugin adds Markdown to the DokuWiki syntax, i.e. it still uses DokuWiki definitions for lists, headers, etc. Thus, markdowku enables you to use internal links, mix Markdown with other plugins and other syntaxes and have clean section headers and media embedding. | ||
Line 101: | Line 133: | ||
===== Discussion ===== | ===== Discussion ===== | ||
+ | ==== Plugin abandoned? ==== | ||
+ | |||
+ | --- [[user> | ||
- | ==== Be great to use .md extension instead of .txt ==== | + | --- [[user> |
- | If it used .md, I might be able to keep it synced | + | --- [[user> |
+ | --- [[user> |
plugin/markdowku.1487526655.txt.gz · Last modified: 2017-02-19 18:50 by 2a02:168:4638:a:f1de:b72a:604e:16e0