summaryrefslogtreecommitdiff
path: root/riki.md
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2022-07-31 08:24:24 +0000
committerLars Wirzenius <liw@liw.fi>2022-07-31 08:24:24 +0000
commit65c453b9b8499eb4a273bfd6f013608b9af23844 (patch)
treeca7932482c933447f96004673e284c94ee86f07d /riki.md
parentbc9493725346d909c305fcaacd06c448e303cd05 (diff)
parentec41f376c51ad990c67015829d24daba65cd2538 (diff)
downloadriki-65c453b9b8499eb4a273bfd6f013608b9af23844.tar.gz
Merge branch 'definition-lists' into 'main'
detect definition lists, fail if found Closes #5 See merge request larswirzenius/riki!29
Diffstat (limited to 'riki.md')
-rw-r--r--riki.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/riki.md b/riki.md
index 6fc0d53..e208baa 100644
--- a/riki.md
+++ b/riki.md
@@ -334,6 +334,52 @@ then AST of site/page.mdwn matches that of output/page.html
* [x] done
~~~
+## Definition list
+
+_Requirement: Markup indicating use of a definition list should be
+flagged as an error._
+
+Justification: Neither the CommonMark specification, nor GitHub
+Flavored Markdown, supports definition lists, even though some
+Markdown variants do. The Markdown parser Riki uses doesn't support
+it.
+
+~~~scenario
+given an installed riki
+
+given file site/page.mdwn from dl-1
+when I try to run riki build --plain-body site output
+then command fails
+then stderr contains "definition list"
+
+given file site/page.mdwn from dl-2
+when I try to run riki build --plain-body site output
+then command fails
+then stderr contains "definition list"
+
+given file site/page.mdwn from dl-3
+when I run riki build --plain-body site output
+then file output/page.html contains ": bar"
+~~~
+
+~~~{#dl-1 .file}
+foo
+: bar
+~~~
+
+~~~{#dl-2 .file}
+foo
+
+: bar
+~~~
+
+~~~{#dl-3 .file}
+foo
+
+<!-- no colon at beginning of line here -->: bar
+~~~
+
+
## Input files other than Markdown
_Requirement: Input files that aren't Markdown files must be copied