• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..Today-

PaxHeader/.DS_Store/H09-Oct-2022-

conf/H09-Oct-2022-154

images/H09-Oct-2022-

lang/H09-Oct-2022-186

src/H09-Oct-2022-1,659840

vendor/H09-Oct-2022-20,50812,179

.DS_StoreH A D08-Oct-20226 KiB

._.DS_StoreH A D08-Oct-2022120

README.mdH A D14-Apr-20222 KiB3522

action.phpH A D14-Apr-20221.4 KiB4118

composer.jsonH A D08-Oct-2022645 3232

composer.lockH A D01-Feb-20224 KiB113112

plugin.info.txtH A D08-Oct-2022208 77

script.jsH A D01-Feb-20221.1 KiB5855

README.md

1Dokuwiki Commonmark Plugin
2===========================
3
4## Description
5This is another plugin for parsing Commonmark / Markdown document in Dokuwiki.
6
7While there are many Markdown plugins (for example, [markdownu](https://www.dokuwiki.org/plugin:markdowku), [mdpage](https://www.dokuwiki.org/plugin:mdpage)) available, this plugin processes Markdown text in different approach:
8
91. check that Markdown indicator ('\<!DOCTYPE markdown\>') is included on the document
102. if exists, parses entire document and renders to DW syntax
113. After pre-rendering, passes the result to DW parser and process as usual
12
13If you want to parse all DW pages as Commonmark without specific doctype, you can enable `force_commonmark` option on config. But this action may conflit with existing document of DW markup, so please use it carefully.
14## Compatibility
15Commonmark plugin aims for complete compatiblity of Markdown in Dokuwiki. Most Markdown syntax have corresponding DW syntax, so it will work without problem; but in some cases, Markdown syntax do not matches DW specification one-by-one, or vice versa. Here is a list of known ambiguities between Commonmark and Dokuwiki, and its implements in the plugin:
16
17- Since DW do not parses raw HTML without `htmlok` config, [HTML blocks](https://spec.commonmark.org/0.30/#html-blocks) is passed.
18- When adding `html` as [info string](https://spec.commonmark.org/0.28/#info-string) in [Fenced code blocks](https://spec.commonmark.org/0.30/#fenced-code-blocks), it parse to DW's [\<HTML\>](https://www.dokuwiki.org/wiki:syntax#embedding_html_and_php) block; In case of `nowiki`, `<nowiki>` syntax will be parsed; if `dokuwiki`, raw DW code will be passed. For example:
19
20````
21```dokuwiki
22<sub>subscript</sub>
23```
24````
25
26
27
28Commonmark plugin would conflit with other markdown-related plugins, including Mdpage.
29
30Due to the concept, section edit will not work, or at least recognize the section as broken snippet rather than expected. This bug will be fixed in later version.
31
32## License
33
34- icons: Apache License from https://www.iconbolt.com/
35