reference.slw (1904B)
1 ## REFERENCE 2 3 Files processed by **slweb** are using a minimal subset of Markdown with added 4 directives. Supported **Markdown features** are: 5 6 - **Paragraphs.** 7 Text surrounded by newlines will be put inside `<p></p>` tags. 8 - **Headings.** 9 A line starting with `#` followed by space will be put inside 10 `<h?></h?>`, where 11 `?` stands for 1-4, depending on the number of 12 hashtags. 13 - **Bold/italic (limited).** 14 Text inside `\*asterisks\*` or 15 `\_underlines\_` will be put inside 16 `<em></em>`. Text inside 17 `\*\*double asterisks\*\*` will be put inside 18 `<strong></strong>`. 19 - **Backticks.** 20 Text inside `\`backticks\`` will be put inside 21 `<code></code>` (one per line, both backticks need to be on the same line). 22 - **Links (limited).** 23 The construct `\[A link](https://example.com)` will be converted into 24 `<a href="https://example.com">A link</a>`. 25 - **Line breaks.** 26 Space followed by a newline will be turned into `<br />`. 27 28 29 **Directives** include: 30 31 - **Class divs.** 32 Directive `\{.myclass}\{/.myclass}` will be transformed into 33 `<div class="myclass"></div>`. 34 - **Id divs.** 35 Directive `\{#myid}\{/#myid}` will be transformed into 36 `<div id="myid"></div>`. 37 - **General tags.** 38 Directive `\{sometag}\{/sometag}` will be transformed into 39 `<sometag></sometag>`. 40 - **Includes.** 41 Directive `\{include "somefile"}` will run 42 `slweb -b` on _somefile.slw_ (related 43 to the directory containing the file containing the directive) and include the 44 resulting {abbr}HTML{/abbr}. Directive needs to start at the beginning of the line. 45 - **Brand “watermark”.** 46 Directive `\{made-by}` is converted into a div containing the 47 “watermark” text and a link to the **slweb** home page.