You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,35 +20,35 @@ This plugin can be installed via:
20
20
python -m pip install pelican-markdown-include
21
21
```
22
22
23
-
As long as you have not explicitly added a `PLUGINS` setting to your Pelican settings file, then the newly-installed plugin should be automatically detected and enabled. Otherwise, you must add `md_include` to your existing `PLUGINS` list. For more information, please see the [How to Use Plugins](https://docs.getpelican.com/en/latest/plugins.html#how-to-use-plugins) documentation.
23
+
As long as there is no `PLUGINS` setting in the Pelican settings file, the newlyinstalled plugin should be detected and enabled automatically. Otherwise, you must add `md_include` to your existing `PLUGINS` list. For more information, please refer to the [How to Use Plugins](https://docs.getpelican.com/en/latest/plugins.html#how-to-use-plugins) documentation.
24
24
25
25
26
26
Usage
27
27
-----
28
28
29
-
The syntax for use within Pelican articles is `{!filename!}`. According to the documentation of the [Markdown-Include extension][], this statement will be replaced by the contents of `filename` and will work recursively. The replacement is done prior to any other Markdown processing, so any Markdown syntax that is wanted can be used within the included files. For more details, see the [Markdown-Include extension documentation][].
29
+
The syntax to use in Pelican articles is `{!filename!}`. According to the documentation of the [Markdown-Include extension][], this statement will be replaced by the contents of `filename` and will work recursively. This replacement occurs before any other Markdown processing, so any desired Markdown syntax can be used within the included files. For more details, see the [Markdown-Include extension documentation][].
The following variables control the behavior of the pluginand can be set in the Pelican settings file:
37
+
The following variables control the plugin's behavior and can be configured in the Pelican settings file:
38
38
39
-
-`MD_INCLUDE_BASE_PATH`: By default, the file name is given relative to the directory from where Pelican is run. This can be changed via this variable.
39
+
-`MD_INCLUDE_BASE_PATH`: By default, the file name is given relative to the directory from which Pelican is run. This can be changed via this variable.
40
40
41
41
-`MD_INCLUDE_ENCODING`: The encoding of the included files. Default: `"utf-8"`
42
42
43
-
-`MD_INCLUDE_INHERIT_HEADING_DEPTH`: If `True`, increases headings on included file by amount of previous heading. Combines with `MD_HEADING_OFFSET` option below. Default: `False`
43
+
-`MD_INCLUDE_INHERIT_HEADING_DEPTH`: If set to `True`, increases the headings in the included file by the amount of the previous heading. This option can be combined with the `MD_HEADING_OFFSET` option, which is documented below. Default: `False`
44
44
45
-
-`MD_HEADING_OFFSET`: Increases heading depth by a specific amount, in addition to the `MD_INCLUDE_INHERIT_HEADING_DEPTH` option. Default: `0`
45
+
-`MD_HEADING_OFFSET`: Increases the heading depth by a specific amount, in addition to the `MD_INCLUDE_INHERIT_HEADING_DEPTH` option. Default: `0`
46
46
47
47
48
48
Alternatives to this Plugin
49
49
---------------------------
50
50
51
-
Pelican allows the use of extra Markdown extensions by declaring them in the `MARKDOWN` configuration variable. However, as [explained][] in the Pelican documentation, adding new extensions via the `MARKDOWN` setting is awkward, because all the extensions loaded by default must also be explicitly listed. In addition to avoiding this problem, this plugin provides a “Pelican-ish” way of setting the configuration values of the Markdown-Include extension (`base_path`, `encoding`, `inherit_heading_depth`, and `heading_offset`). Furthermore, the [Markdown-Include extension][] must be installed in a place where Pelican can find it, which may be tricky.
51
+
Pelican allows the use of additional Markdown extensions by declaring them in the `MARKDOWN` configuration variable. However, as [explained][] in the Pelican documentation, adding new extensions via the `MARKDOWN` setting is cumbersome because it requires explicitly listing all the extensions loaded by default. This plugin provides a “Pelican-ish” way of setting the configuration values of the Markdown-Include extension (`base_path`, `encoding`, `inherit_heading_depth`, and `heading_offset`), thus avoiding this problem. Furthermore, the [Markdown-Include extension][] must be installed in a place where Pelican can find it, which may be tricky.
0 commit comments