conwaymd.github.io/index.html at master · conwaymd/conwaymd.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="author" content="Conway">
<meta name="description" content="Documentation for Conway-Markdown (CMD).">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="/cmd.css">
<link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
<link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
<link rel="manifest" href="/site.webmanifest">
<link rel="mask-icon" href="/safari-pinned-tab.svg" color="#7000ff">
<meta name="msapplication-TileColor" content="#00aba9">
<meta name="theme-color" content="#ffffff">
<title>Conway-Markdown (conwaymd, CMD) v6.0.0</title>
</head>
<body>
<h1>Conway-Markdown (conwaymd, CMD) v6.0.0</h1>
<p>
Conway-Markdown is:
</p>
<ul>
<li>
A replacement-driven markup language inspired by Markdown.
</li>
<li>
A demonstration of the folly of throwing regex at a parsing problem.
</li>
<li>
The result of someone joking that
<q>the filenames would look like Windows executables from the 90s</q>.
</li>
<li>
Implemented in <a href="https://packages.debian.org/stable/python3">Python 3.{whatever Debian stable is at}</a>.
</li>
<li>
Licensed under "MIT No Attribution" (MIT-0).
</li>
</ul>
<h2 id="contents"><a href="#contents" class="permalink" aria-label="Permalink"></a>Contents</h2>
<ul>
<li>
<a href="#installation">Installation</a>
</li>
<li>
<a href="#usage-cli">Usage (command line)</a>
</li>
<li>
<a href="#usage-scripting">Usage (scripting example)</a>
</li>
<li>
<a href="#authoring-cmd-files">Authoring CMD files</a>
</li>
<li>
<a href="#standard-rules">Standard CMD replacement rules</a>
<ul>
<li>
<a href="#standard-queued-replacements">Standard queued replacements</a>
<ol start="0">
<li>
<a href="#placeholder-markers"><code>#placeholder-markers</code></a>
</li>
<li>
<a href="#literals"><code>#literals</code></a>
</li>
<li>
<a href="#display-code"><code>#display-code</code></a>
</li>
<li>
<a href="#comments"><code>#comments</code></a>
</li>
<li>
<a href="#divisions"><code>#divisions</code></a>
</li>
<li>
<a href="#blockquotes"><code>#blockquotes</code></a>
</li>
<li>
<a href="#unordered-lists"><code>#unordered-lists</code></a>
</li>
<li>
<a href="#ordered-lists"><code>#ordered-lists</code></a>
</li>
<li>
<a href="#tables"><code>#tables</code></a>
</li>
<li>
<a href="#headings"><code>#headings</code></a>
</li>
<li>
<a href="#paragraphs"><code>#paragraphs</code></a>
</li>
<li>
<a href="#inline-code"><code>#inline-code</code></a>
</li>
<li>
<a href="#boilerplate"><code>#boilerplate</code></a>
</li>
<li>
<a href="#boilerplate-properties"><code>#boilerplate-properties</code></a>
</li>
<li>
<a href="#cmd-properties"><code>#cmd-properties</code></a>
</li>
<li>
<a href="#boilerplate-protect"><code>#boilerplate-protect</code></a>
</li>
<li>
<a href="#backslash-escapes"><code>#backslash-escapes</code></a>
</li>
<li>
<a href="#backslash-continuations"><code>#backslash-continuations</code></a>
</li>
<li>
<a href="#reference-definitions"><code>#reference-definitions</code></a>
</li>
<li>
<a href="#specified-images"><code>#specified-images</code></a>
</li>
<li>
<a href="#referenced-images"><code>#referenced-images</code></a>
</li>
<li>
<a href="#explicit-links"><code>#explicit-links</code></a>
</li>
<li>
<a href="#specified-links"><code>#specified-links</code></a>
</li>
<li>
<a href="#referenced-links"><code>#referenced-links</code></a>
</li>
<li>
<a href="#inline-semantics"><code>#inline-semantics</code></a>
</li>
<li>
<a href="#escape-idle-html"><code>#escape-idle-html</code></a>
</li>
<li>
<a href="#whitespace"><code>#whitespace</code></a>
</li>
<li>
<a href="#placeholder-unprotect"><code>#placeholder-unprotect</code></a>
</li>
</ol>
</li>
<li>
<a href="#standard-unqueued-replacements">Standard unqueued replacements</a>
<ul>
<li>
<a href="#placeholder-protect"><code>#placeholder-protect</code></a>
</li>
<li>
<a href="#de-indent"><code>#de-indent</code></a>
</li>
<li>
<a href="#escape-html"><code>#escape-html</code></a>
</li>
<li>
<a href="#trim-whitespace"><code>#trim-whitespace</code></a>
</li>
<li>
<a href="#reduce-whitespace"><code>#reduce-whitespace</code></a>
</li>
<li>
<a href="#code-tag-wrap"><code>#code-tag-wrap</code></a>
</li>
<li>
<a href="#prepend-newline"><code>#prepend-newline</code></a>
</li>
<li>
<a href="#unordered-list-items"><code>#unordered-list-items</code></a>
</li>
<li>
<a href="#ordered-list-items"><code>#ordered-list-items</code></a>
</li>
<li>
<a href="#mark-table-headers-for-preceding-table-data"><code>#mark-table-headers-for-preceding-table-data</code></a>
</li>
<li>
<a href="#table-headers"><code>#table-headers</code></a>
</li>
<li>
<a href="#table-data"><code>#table-data</code></a>
</li>
<li>
<a href="#unmark-table-headers-for-preceding-table-data"><code>#unmark-table-headers-for-preceding-table-data</code></a>
</li>
<li>
<a href="#table-rows"><code>#table-rows</code></a>
</li>
<li>
<a href="#table-head"><code>#table-head</code></a>
</li>
<li>
<a href="#table-body"><code>#table-body</code></a>
</li>
<li>
<a href="#table-foot"><code>#table-foot</code></a>
</li>
<li>
<a href="#suppress-scheme"><code>#suppress-scheme</code></a>
</li>
<li>
<a href="#angle-bracket-wrap"><code>#angle-bracket-wrap</code></a>
</li>
</ul>
</li>
</ul>
</li>
<li>
<a href="#replacement-rule-syntax">CMD replacement rule syntax</a>
<ul>
<li>
<a href="#ReplacementSequence"><code>ReplacementSequence</code></a>
</li>
<li>
<a href="#PlaceholderMarkerReplacement"><code>PlaceholderMarkerReplacement</code></a>
</li>
<li>
<a href="#PlaceholderProtectionReplacement"><code>PlaceholderProtectionReplacement</code></a>
</li>
<li>
<a href="#PlaceholderUnprotectionReplacement"><code>PlaceholderUnprotectionReplacement</code></a>
</li>
<li>
<a href="#DeIndentationReplacement"><code>DeIndentationReplacement</code></a>
</li>
<li>
<a href="#OrdinaryDictionaryReplacement"><code>OrdinaryDictionaryReplacement</code></a>
</li>
<li>
<a href="#RegexDictionaryReplacement"><code>RegexDictionaryReplacement</code></a>
</li>
<li>
<a href="#FixedDelimitersReplacement"><code>FixedDelimitersReplacement</code></a>
</li>
<li>
<a href="#ExtensibleFenceReplacement"><code>ExtensibleFenceReplacement</code></a>
</li>
<li>
<a href="#PartitioningReplacement"><code>PartitioningReplacement</code></a>
</li>
<li>
<a href="#InlineAssortedDelimitersReplacement"><code>InlineAssortedDelimitersReplacement</code></a>
</li>
<li>
<a href="#HeadingReplacement"><code>HeadingReplacement</code></a>
</li>
<li>
<a href="#ReferenceDefinitionReplacement"><code>ReferenceDefinitionReplacement</code></a>
</li>
<li>
<a href="#SpecifiedImageReplacement"><code>SpecifiedImageReplacement</code></a>
</li>
<li>
<a href="#ReferencedImageReplacement"><code>ReferencedImageReplacement</code></a>
</li>
<li>
<a href="#ExplicitLinkReplacement"><code>ExplicitLinkReplacement</code></a>
</li>
<li>
<a href="#SpecifiedLinkReplacement"><code>SpecifiedLinkReplacement</code></a>
</li>
<li>
<a href="#ReferencedLinkReplacement"><code>ReferencedLinkReplacement</code></a>
</li>
</ul>
</li>
<li>
<a href="#cmd-placeholders">CMD placeholders</a>
</li>
<li>
<a href="#cmd-attribute-specifications">CMD attribute specifications</a>
</li>
<li>
<a href="#repository-links">Repository links</a>
</li>
</ul>
<h2 id="installation"><a href="#installation" class="permalink" aria-label="Permalink"></a>Installation</h2>
<p>
Conway-Markdown is <a href="https://pypi.org/project/conwaymd/">published to PyPI as <code>conwaymd</code></a>:
</p>
<pre><code>$ pip3 install conwaymd
</code></pre>
<ul>
<li>
If simply using as a command line tool, do <code>pipx</code> instead of <code>pip3</code>
to avoid having to set up a virtual environment.
</li>
<li>
If using Windows, do <code>pip</code> instead of <code>pip3</code>.
</li>
</ul>
<h2 id="usage-cli"><a href="#usage-cli" class="permalink" aria-label="Permalink"></a>Usage (command line)</h2>
<pre><code>$ cmd [-h] [-v] [-a] [-x] [file.cmd ...]

Convert Conway-Markdown (CMD) to HTML.

positional arguments:
  file.cmd       name of CMD file to be converted (can be abbreviated as
                 `file` or `file.` for increased productivity)

options:
  -h, --help     show this help message and exit
  -v, --version  show program's version number and exit
  -a, --all      convert all CMD files under the working directory
  -x, --verbose  run in verbose mode (prints every replacement applied)
</code></pre>
<p>
On Windows:
</p>
<ul>
<li>
Use the aliases <code>cmd-</code> or <code>conwaymd</code> instead of <code>cmd</code>
to avoid summoning Command Prompt.
</li>
<li>
<strong>Beware not to run any <code>.cmd</code> files by accident;
they might break your computer. God save!</strong>
</li>
</ul>
<h2 id="usage-scripting"><a href="#usage-scripting" class="permalink" aria-label="Permalink"></a>Usage (scripting example)</h2>
<p>
Code:
</p>
<pre><code>from conwaymd.core import cmd_to_html

cmd_content = '''
# Test
==
- This is a *near*-minimal test.
- Here be [__dragons__].
==
[__dragons__]: https://example.com/
'''

html_content = cmd_to_html(cmd_content, cmd_file_name='scripting-test.py')

print(html_content)
</code></pre>
<p>
Output:
</p>
<pre><code>&lt;!DOCTYPE html&gt;
&lt;html lang="en"&gt;
&lt;head&gt;
&lt;meta charset="utf-8"&gt;
&lt;meta name="viewport" content="width=device-width, initial-scale=1"&gt;
&lt;title&gt;Title&lt;/title&gt;
&lt;/head&gt;
&lt;body&gt;
&lt;h1&gt;Test&lt;/h1&gt;
&lt;ul&gt;
&lt;li&gt;
This is a &lt;em&gt;near&lt;/em&gt;-minimal test.
&lt;/li&gt;
&lt;li&gt;
Here be &lt;a href="https://example.com/"&gt;&lt;b&gt;dragons&lt;/b&gt;&lt;/a&gt;.
&lt;/li&gt;
&lt;/ul&gt;
&lt;/body&gt;
&lt;/html&gt;
</code></pre>
<h2 id="authoring-cmd-files"><a href="#authoring-cmd-files" class="permalink" aria-label="Permalink"></a>Authoring CMD files</h2>
<p>
CMD files are parsed thus:
</p>
<pre class="cmd"><code><b class="cmdr">«replacement rules»</b>
«delimiter»
<b class="cmdc">«main content»</b>
</code></pre>
<ul>
<li>
<b><code class="cmd cmdr">«replacement rules»</code></b> are user-defined CMD replacement rules
that will be used in addition to the standard CMD replacement rules.
</li>
<li>
<code class="cmd">«delimiter»</code> is the first occurrence of
3-or-more percent signs on its own line.
(If no <code class="cmd">«delimiter»</code> is found in the file,
the whole file is parsed as <code class="cmd cmdc">«main content»</code>.)
</li>
<li>
<b><code class="cmd cmdc">«main content»</code></b> is the CMD content
that will be converted to HTML according to
the standard and user-defined CMD replacement rules.
</li>
</ul>
<p>
In the implementation:
</p>
<ol>
<li>
An empty <b>replacement queue</b> is initialised.
</li>
<li>
<b><code>STANDARD_RULES</code></b> in <a href="https://github.com/conwaymd/conwaymd/blob/master/conwaymd/constants.py"><code>constants.py</code></a> are parsed,
and CMD replacement rules are added to the replacement queue accordingly.
</li>
<li>
<b><code class="cmd cmdr">«replacement rules»</code></b> in the CMD file are parsed,
and CMD replacement rules are added or inserted into the replacement queue
accordingly.
</li>
<li>
The CMD replacement rules in the replacement queue are
<b>applied sequentially to <code class="cmd cmdc">«main content»</code></b>
to convert it to HTML.
</li>
</ol>
<p>
To get started with writing <b><code class="cmd cmdc">«main content»</code></b>,
read the listing of <a href="#standard-rules">standard CMD replacement rules</a>.
</p>
<p>
To learn about writing user-defined <b><code class="cmd cmdr">«replacement rules»</code></b>,
read about <a href="#replacement-rule-syntax">CMD replacement rule syntax</a>.
</p>
<h2 id="standard-rules"><a href="#standard-rules" class="permalink" aria-label="Permalink"></a>Standard CMD replacement rules</h2>
<p>
This section lists the standard CMD replacement rules
as defined by the constant string <b><code>STANDARD_RULES</code></b> in <a href="https://github.com/conwaymd/conwaymd/blob/master/conwaymd/constants.py"><code>constants.py</code></a>.
</p>
<p>
Some replacement rules are <a href="#standard-queued-replacements">queued</a>,
in that they appear explicitly in the replacement queue.
</p>
<p>
Other replacement rules are <a href="#standard-unqueued-replacements">unqueued</a>,
in that they do not appear explicitly in the replacement queue.
However, they might be called by queued replacements.
</p>
<h3 id="standard-queued-replacements"><a href="#standard-queued-replacements" class="permalink" aria-label="Permalink"></a>Standard queued replacements</h3>
<h4 id="placeholder-markers"><a href="#placeholder-markers" class="permalink" aria-label="Permalink"></a>0. <code>#placeholder-markers</code></h4>
<details open>
<summary>Definition</summary>
<pre class="cmd cmdr"><code>PlaceholderMarkerReplacement: #placeholder-markers
- queue_position: ROOT
</code></pre>
</details>
<details open>
<summary>Description</summary>
<p>
Replaces occurrences of the placeholder marker <code>«U+F8FF»</code>
with a <a href="#cmd-placeholders">placeholder</a>
so that the occurrences will not be confounding.
</p>
</details>
<h4 id="literals"><a href="#literals" class="permalink" aria-label="Permalink"></a>1. <code>#literals</code></h4>
<details open>
<summary>Definition</summary>
<pre class="cmd cmdr"><code>ExtensibleFenceReplacement: #literals
- queue_position: AFTER #placeholder-markers
- syntax_type: INLINE
- allowed_flags:
    u=KEEP_HTML_UNESCAPED
    i=KEEP_INDENTED
    w=REDUCE_WHITESPACE
- prologue_delimiter: &lt;
- extensible_delimiter: `
- content_replacements:
    #escape-html
    #de-indent
    #trim-whitespace
    #reduce-whitespace
    #placeholder-protect
- epilogue_delimiter: &gt;
</code></pre>
</details>
<details open>
<summary>Syntax</summary>
<pre class="cmd cmdc"><code><b>&lt;</b><b>`</b> «content» <b>`</b><b>&gt;</b>
</code></pre>
<pre class="cmd cmdc"><code>«flags»<b>&lt;</b><b>`</b> «content» <b>`</b><b>&gt;</b>
</code></pre>
<ul>
<li>
<code class="cmd cmdc">«flags»</code>:
<ul>
<li>
<code class="cmd cmdc">u</code>: keep HTML unescaped (do not apply <a href="#escape-html"><code>#escape-html</code></a>)
</li>
<li>
<code class="cmd cmdc">i</code>: keep indented (do not apply <a href="#de-indent"><code>#de-indent</code></a>)
</li>
<li>
<code class="cmd cmdc">w</code>: reduce whitespace (apply <a href="#reduce-whitespace"><code>#reduce-whitespace</code></a>)
</li>
</ul>
</li>
<li>
The number of backticks <code class="cmd cmdc"><b>`</b></code>
may be increased arbitrarily.
</li>
</ul>
</details>
<details open>
<summary>Description</summary>
<p>
Preserves <code class="cmd cmdc">«content»</code> literally.
</p>
</details>
<details open>
<summary>Examples</summary>
<ol>
<li>
Write a literal string:
<ul>
<li>
CMD: <code class="cmd cmdc">&lt;` &lt;b&gt;Foo&lt;/b&gt; `&gt;</code>
</li>
<li>
HTML: <code class="html">&amp;lt;b&amp;gt;Foo&amp;lt;/b&amp;gt;</code>
</li>
<li>
Rendered: &lt;b&gt;Foo&lt;/b&gt;
</li>
</ul>
</li>
<li>
Keep HTML unescaped:
<ul>
<li>
CMD: <code class="cmd cmdc">u&lt;` &lt;b&gt;Foo&lt;/b&gt; `&gt;</code>
</li>
<li>
HTML: <code class="html">&lt;b&gt;Foo&lt;/b&gt;</code>
</li>
<li>
Rendered: <b>Foo</b>
</li>
</ul>
</li>
<li>
Increase the number of backticks to include content
that matches the <code>#literals</code> syntax itself:
<ul>
<li>
CMD: <code class="cmd cmdc">&lt;`` Literally &lt;`literal`&gt;. ``&gt;</code>
</li>
<li>
HTML: <code class="html">Literally &amp;lt;`literal`&amp;gt;.</code>
</li>
<li>
Rendered: Literally &lt;`literal`&gt;.
</li>
</ul>
</li>
</ol>
</details>
<h4 id="display-code"><a href="#display-code" class="permalink" aria-label="Permalink"></a>2. <code>#display-code</code></h4>
<details open>
<summary>Definition</summary>
<pre class="cmd cmdr"><code>ExtensibleFenceReplacement: #display-code
- queue_position: AFTER #literals
- syntax_type: BLOCK
- allowed_flags:
    u=KEEP_HTML_UNESCAPED
    i=KEEP_INDENTED
    w=REDUCE_WHITESPACE
- extensible_delimiter: ``
- attribute_specifications: EMPTY
- content_replacements:
    #escape-html
    #de-indent
    #reduce-whitespace
    #code-tag-wrap
    #placeholder-protect
- tag_name: pre
</code></pre>
</details>
<details open>
<summary>Syntax</summary>
<pre class="cmd cmdc"><code><b>``</b>
  «content»
<b>``</b>
</code></pre>
<pre class="cmd cmdc"><code><b>``</b>{«attribute specifications»}
  «content»
<b>``</b>
</code></pre>
<pre class="cmd cmdc"><code>«flags»<b>``</b>
  «content»
<b>``</b>
</code></pre>
<pre class="cmd cmdc"><code>«flags»<b>``</b>{«attribute specifications»}
  «content»
<b>``</b>
</code></pre>
<ul>
<li>
<code class="cmd cmdc">«flags»</code>:
<ul>
<li>
<code class="cmd cmdc">u</code>: keep HTML unescaped (do not apply <a href="#escape-html"><code>#escape-html</code></a>)
</li>
<li>
<code class="cmd cmdc">i</code>: keep indented (do not apply <a href="#de-indent"><code>#de-indent</code></a>)
</li>
<li>
<code class="cmd cmdc">w</code>: reduce whitespace (apply <a href="#reduce-whitespace"><code>#reduce-whitespace</code></a>)
</li>
</ul>
</li>
<li>
The number of backticks <code class="cmd cmdc"><b>`</b></code>
may be increased arbitrarily.
</li>
<li>
<code class="cmd cmdc">«attribute specifications»</code>:
see <a href="#cmd-attribute-specifications">CMD attribute specifications</a>.
</li>
</ul>
</details>
<details open>
<summary>Description</summary>
<p>
Produces (pre-formatted) display code:
</p>
<pre class="html"><code><b>&lt;pre</b>«attribute sequence»<b>&gt;&lt;code&gt;</b>«content»
<b>&lt;/code&gt;&lt;/pre&gt;</b>
</code></pre>
</details>
<details open>
<summary>Examples</summary>
<ol>
<li>
Display code:
<ul>
<li>
CMD:
<pre class="cmd cmdc"><code>``{.java}
  for (int index = 0; index &lt; count; index++)
  {
    // etc. etc.
  }
``
</code></pre>
</li>
<li>
HTML:
<pre class="html"><code>&lt;pre class="java"&gt;&lt;code&gt;for (int index = 0; index &amp;lt; count; index++)
{
  // etc. etc.
}
&lt;/code&gt;&lt;/pre&gt;
</code></pre>
</li>
<li>
Rendered:
<pre class="java"><code>for (int index = 0; index &lt; count; index++)
{
  // etc. etc.
}
</code></pre>
</li>
</ul>
</li>
<li>
Use <a href="#literals"><code>#literals</code></a> with flag <code class="cmd cmdc">u</code> to inject HTML:
<ul>
<li>
CMD:
<pre class="cmd cmdc"><code>``
  Injection of &lt;b&gt; element u&lt;` &lt;b&gt;here&lt;/b&gt; `&gt;.
``
</code></pre>
</li>
<li>
HTML:
<pre class="html"><code>&lt;pre&gt;&lt;code&gt;Injection of &amp;lt;b&amp;gt; element &lt;b&gt;here&lt;/b&gt;.
&lt;/code&gt;&lt;/pre&gt;
</code></pre>
</li>
<li>
Rendered:
<pre><code>Injection of &lt;b&gt; element <b>here</b>.
</code></pre>
</li>
</ul>
</li>
</ol>
</details>
<h4 id="comments"><a href="#comments" class="permalink" aria-label="Permalink"></a>3. <code>#comments</code></h4>
<details open>
<summary>Definition</summary>
<pre class="cmd cmdr"><code>RegexDictionaryReplacement: #comments
- queue_position: AFTER #display-code
* [^\S\n]*
  [&lt;]
    (?P&lt;hashes&gt; [#]+ )
      [\s\S]*?
    (?P=hashes)
  [&gt;]
    --&gt;
</code></pre>
</details>
<details open>
<summary>Syntax</summary>
<pre class="cmd cmdc"><code><b>&lt;</b><b>#</b> «content» <b>#</b><b>&gt;</b>
</code></pre>
<ul>
<li>
The number of hashes <code class="cmd cmdc"><b>#</b></code> may be increased arbitrarily.
</li>
</ul>
</details>
<details open>
<summary>Description</summary>
<p>
Remove CMD comments, along with all preceding whitespace.
</p>
</details>
<details open>
<summary>Examples</summary>
<ol>
<li>
<a href="#display-code"><code>#display-code</code></a> prevails over <code>#comments</code>:
<ul>
<li>
CMD:
<pre class="cmd cmdc"><code>``
  Before.
  &lt;# This be a comment. #&gt;
  After.
``
</code></pre>
</li>
<li>
HTML:
<pre class="html"><code>&lt;pre&gt;&lt;code&gt;Before.
&amp;lt;# This be a comment. #&amp;gt;
After.
&lt;/code&gt;&lt;/pre&gt;
</code></pre>
</li>
<li>
Rendered:
<pre><code>Before.
&lt;# This be a comment. #&gt;
After.
</code></pre>
</li>
</ul>
</li>
<li>
<code>#comments</code> prevail over <a href="#inline-code"><code>#inline-code</code></a>:
<ul>
<li>
CMD: <code class="cmd cmdc">`Before. &lt;# This be a comment. #&gt; After.`</code>
</li>
<li>
HTML: <code class="html">&lt;code&gt;Before. After.&lt;/code&gt;</code>
</li>
<li>
Rendered: <code>Before. After.</code>
</li>
</ul>
</li>
<li>
Use <a href="#literals"><code>#literals</code></a> to make <a href="#inline-code"><code>#inline-code</code></a> prevail over <code>#comments</code>:
<ul>
<li>
CMD:
<code class="cmd cmdc">` &lt;`Before. &lt;# This be a comment. #&gt; After.`&gt; `</code>
</li>
<li>
HTML:
<code class="html">&lt;code&gt;Before. &amp;lt;# This be a comment. #&amp;gt; After.&lt;/code&gt;</code>
</li>
<li>
Rendered:
<code>Before. &lt;# This be a comment. #&gt; After.</code>
</li>
</ul>
</li>
</ol>
</details>
<h4 id="divisions"><a href="#divisions" class="permalink" aria-label="Permalink"></a>4. <code>#divisions</code></h4>
<details open>
<summary>Definition</summary>
<pre class="cmd cmdr"><code>ExtensibleFenceReplacement: #divisions
- queue_position: AFTER #comments
- syntax_type: BLOCK
- extensible_delimiter: ||
- attribute_specifications: EMPTY
- content_replacements:
    #divisions
    #prepend-newline
- tag_name: div
</code></pre>
</details>
<details open>
<summary>Syntax</summary>
<pre class="cmd cmdc"><code><b>||</b>
  «content»
<b>||</b>
</code></pre>
<pre class="cmd cmdc"><code><b>||</b>{«attribute specifications»}
  «content»
<b>||</b>
</code></pre>
<ul>
<li>
The number of pipes <code class="cmd cmdc"><b>|</b></code> may be increased arbitrarily.
</li>
<li>
<code class="cmd cmdc">«attribute specifications»</code>:
see <a href="#cmd-attribute-specifications">CMD attribute specifications</a>.
</li>
</ul>
</details>
<details open>
<summary>Description</summary>
<p>
Produces a division:
</p>
<pre class="html"><code><b>&lt;div</b>«attribute sequence»<b>&gt;</b>
«content»
<b>&lt;/div&gt;</b>
</code></pre>
</details>
<details open>
<summary>Examples</summary>
<ol>
<li>
Division:
<ul>
<li>
CMD:
<pre class="cmd cmdc"><code>||{#test-div-id .test-div-class}
  This be a division.
||
</code></pre>
</li>
<li>
HTML:
<pre class="html"><code>&lt;div id="test-div-id" class="test-div-class"&gt;
This be a division.
&lt;/div&gt;
</code></pre>
</li>
</ul>
</li>
<li>
More pipes for nested divisions:
<ul>
<li>
CMD:
<pre class="cmd cmdc"><code>||||{.outer}
  ||{.inner}
    This be a division.
  ||
||||
</code></pre>
</li>
<li>
HTML:
<pre class="html"><code>&lt;div class="outer"&gt;
&lt;div class="inner"&gt;
This be a division.
&lt;/div&gt;
&lt;/div&gt;
</code></pre>
</li>
</ul>
</li>
</ol>
</details>
<h4 id="blockquotes"><a href="#blockquotes" class="permalink" aria-label="Permalink"></a>5. <code>#blockquotes</code></h4>
<details open>
<summary>Definition</summary>
<pre class="cmd cmdr"><code>ExtensibleFenceReplacement: #blockquotes
- queue_position: AFTER #divisions
- syntax_type: BLOCK
- extensible_delimiter: ""
- attribute_specifications: EMPTY
- content_replacements:
    #blockquotes
    #prepend-newline
- tag_name: blockquote
</code></pre>
</details>
<details open>
<summary>Syntax</summary>
<pre class="cmd cmdc"><code><b>""</b>
  «content»
<b>""</b>
</code></pre>
<pre class="cmd cmdc"><code><b>""</b>{«attribute specifications»}
  «content»
<b>""</b>
</code></pre>
<ul>
<li>
The number of double-quotes <code class="cmd cmdc"><b>"</b></code>
may be increased arbitrarily.
</li>
<li>
<code class="cmd cmdc">«attribute specifications»</code>:
see <a href="#cmd-attribute-specifications">CMD attribute specifications</a>.
</li>
</ul>
</details>
<details open>
<summary>Description</summary>
<p>
Produces a blockquote:
</p>
<pre class="html"><code><b>&lt;blockquote</b>«attribute sequence»<b>&gt;</b>
«content»
<b>&lt;/blockquote&gt;</b>
</code></pre>
</details>
<details open>
<summary>Examples</summary>
<ol>
<li>
Blockquote:
<ul>
<li>
CMD:
<pre class="cmd cmdc"><code>""{#test-blockquote-id .test-blockquote-class}
  This be a blockquote.
""
</code></pre>
</li>
<li>
HTML:
<pre class="html"><code>&lt;blockquote id="test-blockquote-id" class="test-blockquote-class"&gt;
This be a blockquote.
&lt;/blockquote&gt;
</code></pre>
</li>
</ul>
</li>
</ol>
</details>
<h4 id="unordered-lists"><a href="#unordered-lists" class="permalink" aria-label="Permalink"></a>6. <code>#unordered-lists</code></h4>
<details open>
<summary>Definition</summary>
<pre class="cmd cmdr"><code>ExtensibleFenceReplacement: #unordered-lists
- queue_position: AFTER #blockquotes
- syntax_type: BLOCK
- extensible_delimiter: ==
- attribute_specifications: EMPTY
- content_replacements:
    #unordered-lists
    #unordered-list-items
    #prepend-newline
- tag_name: ul
</code></pre>
</details>
<details open>
<summary>Syntax</summary>
<pre class="cmd cmdc"><code><b>==</b>
<b>-</b> «item»
«...»
<b>==</b>
</code></pre>
<pre class="cmd cmdc"><code><b>==</b>{«attribute specifications»}
<b>-</b>{«attribute specifications»} «item»
«...»
<b>==</b>
</code></pre>
<ul>
<li>
The number of equals signs <code class="cmd cmdc"><b>=</b></code>
may be increased arbitrarily.
</li>
<li>
The item delimiter may be
<code class="cmd cmdc"><b>-</b></code>, <code class="cmd cmdc"><b>+</b></code>, or <code class="cmd cmdc"><b>*</b></code>,
see <a href="#unordered-list-items"><code>#unordered-list-items</code></a>.
</li>
<li>
<code class="cmd cmdc">«attribute specifications»</code>:
see <a href="#cmd-attribute-specifications">CMD attribute specifications</a>.
</li>
</ul>
</details>
<details open>
<summary>Description</summary>
<p>
Produces an unordered list:
</p>
<pre class="html"><code><b>&lt;ul</b>«attribute sequence»<b>&gt;</b>
<b>&lt;li&gt;</b>
«item»
<b>&lt;/li&gt;</b>
«...»
<b>&lt;/ul&gt;</b>
</code></pre>
</details>
<details open>
<summary>Examples</summary>
<ol>
<li>
Nested list: