File: markdown_sample.md

package info (click to toggle)
sphinx-substitution-extensions 2026.01.12-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 332 kB
  • sloc: python: 2,342; makefile: 3
file content (146 lines) | stat: -rw-r--r-- 2,200 bytes parent folder | download
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
Samples for substitution directives in Markdown
===============================================

Configuration
-------------

```{literalinclude} conf.py
:language: python
```

``code-block``
--------------

```{code-block} markdown

    ```{code-block} markdown

       echo "The author is |author|"
    ```

    ```{code-block} markdown
    :substitutions:

       echo "The author is |author|"
    ```

    or, with the value of the `myst_sub_delimiters` `conf.py` setting:

    ```{code-block} markdown

       echo "The author is {{author}}"
    ```

    ```{code-block} markdown
    :substitutions:

       echo "The author is {{author}}"
    ```
```

=>

```{code-block} markdown

    echo "The author is |author|"
```

```{code-block} markdown
    :substitutions:

    echo "The author is |author|"
```

```{code-block} markdown

    echo "The author is {{author}}"
```

```{code-block} markdown
    :substitutions:

    echo "The author is {{author}}"
```

Inline ``:substitution-code:``
------------------------------

```{code-block} markdown

   {substitution-code}`The author is {{author}}`
```

=>

{substitution-code}`The author is {{author}}`

``substitution-download``
-------------------------

```{code-block} markdown

   {substitution-download}`Script by {{author}} <../source/Eleanor.txt>`
```

=>

{substitution-download}`Script by {{author}} <../source/Eleanor.txt>`

``literalinclude``
------------------

### Content substitutions

```{code-block} markdown

    ```{literalinclude} sample_include.txt
    ```

    ```{literalinclude} sample_include.txt
    :content-substitutions:
    ```
```

=>

```{literalinclude} sample_include.txt
```

```{literalinclude} sample_include.txt
:content-substitutions:
```

### Path substitutions

```{code-block} markdown

    ```{literalinclude} {{author}}.txt
    :path-substitutions:
    ```
```

=>

```{literalinclude} {{author}}.txt
:path-substitutions:
```

``image``
---------

### Path substitutions

```{code-block} markdown

    ```{image} {{author}}_diagram.png
    :path-substitutions:
    :alt: Diagram for {{author}}
    ```
```

=>

```{image} {{author}}_diagram.png
:path-substitutions:
:alt: Diagram for {{author}}
```