~strahinja/slweb

slweb/examples/includes/reference.slw -rw-r--r-- 1.9 KiB
c810f6b8Страхиња Радић slweb.do: Adjust to the new version.h build 15 days ago
                                                                                
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
## REFERENCE

Files processed by **slweb** are using a minimal subset of Markdown with added
directives.  Supported **Markdown features** are:

- **Paragraphs.**
    Text surrounded by newlines will be put inside `<p></p>` tags.
- **Headings.**
    A line starting with `#` followed by space will be put inside
    `<h?></h?>`, where
    `?` stands for 1-4, depending on the number of
    hashtags.
- **Bold/italic (limited).**
    Text inside `\*asterisks\*` or
    `\_underlines\_` will be put inside
    `<em></em>`. Text inside
    `\*\*double asterisks\*\*` will be put inside
    `<strong></strong>`.
- **Backticks.**
    Text inside `\`backticks\`` will be put inside
    `<code></code>` (one per line, both backticks need to be on the same line).
- **Links (limited).**
    The construct `\[A link](https://example.com)` will be converted into
    `<a href="https://example.com">A link</a>`.
- **Line breaks.**
    Space followed by a newline will be turned into `<br />`.


**Directives** include:

- **Class divs.**
    Directive `\{.myclass}\{/.myclass}` will be transformed into
    `<div class="myclass"></div>`.
- **Id divs.**
    Directive `\{#myid}\{/#myid}` will be transformed into
    `<div id="myid"></div>`.
- **General tags.**
    Directive `\{sometag}\{/sometag}` will be transformed into
    `<sometag></sometag>`.
- **Includes.**
    Directive `\{include "somefile"}` will run
    `slweb -b` on _somefile.slw_ (related
    to the directory containing the file containing the directive) and include the
    resulting {abbr}HTML{/abbr}. Directive needs to start at the beginning of the line.
- **Brand “watermark”.**
    Directive `\{made-by}` is converted into a div containing the
    “watermark” text and a link to the **slweb** home page.