# Markdown-Include
This is an extension to [Python-Markdown](https://pythonhosted.org/Markdown/)
which provides an "include" function, similar to that found in
LaTeX (and also the C pre-processor and Fortran). I originally wrote it for my
[FORD](https://github.com/cmacmackin/ford) Fortran auto-documentation generator.
## Installation
This module can now be installed using ``pip``.
pip install markdown-include
## Tests
Use the unittest module
```bash
python -m unittest discover unittests/
```
## Usage
This module can be used in a program in the following way:
```python
import markdown
html = markdown.markdown(source, extensions=['markdown_include.include'])
```
Markdown-Include can also be included in MkDocs projects like below:
```yaml
markdown_extensions:
- markdown_include.include:
base_path: docs
```
The syntax for use within your Markdown files is ``{!filename!}``. This
statement will be replaced by the contents of ``filename``. Markdown-Include
will work recursively, so any included files within ``filename`` will also be
included. This replacement is done prior to any other
Markdown processing, so any Markdown syntax that you want can be used within
your included files. Note that this is a change from the previous version.
It was felt that this syntax was less likely to conflict with any code
fragments present in the Markdown.
By default, all file-names are evaluated relative to the location from which
Markdown is being called. If you would like to change the directory relative to
which paths are evaluated, then this can be done by specifying the extension
setting ``base_path``.
### Line Ranges
You can also define specific lines or line ranges to include by specifying `lines`:
```Markdown
{!filename!lines=1 3 8-10 2}
```
`lines` takes a sequence of integers separated by spaces (one or more), or it can also
take line ranges specified with a start line and an end line separated by a dash (`-`).
In the example above, it would read the file called `filename` and include the lines
`1`, `3`, `8`, `9`, `10`, `2`.
Notice that line `9` was not explicitly set. But it was still included as part of the
range `8-10`.
Also, notice that line `2` is set *after* the range `8-10`. This means that the
line `2` in `filename` will be included *after* (below) the range `8-10`.
You can use this to include lines in a different order than the original file. But it
also means that if you want to preserve the original order, you have to pay attention
to the order in which you specify the lines.
## Configuration
The following settings can be specified when initialising the plugin.
- __base_path__: Default location from which to evaluate relative
paths for the include statement. (Default: the run-directory.)
- __encoding__: Encoding of the files used by the include statement. (Default: utf-8.)
- __inheritHeadingDepth__ : If true, increases headings on include
file by amount of previous heading. Combiens with headingOffset
option, below. (Default: False.)
- __headingOffset__: Increases heading depth by a specific ammount, in
addition to the inheritHeadingDepth Option. (Default: 0)
- __throwException__: When true, if the extension is unable to find an
included file it will throw an exception which the user can
catch. If false (default), a warning will be printed and Markdown
will continue parsing the file.
## Examples
An example of setting the base path and file encoding is given below:
```python
import markdown
from markdown_include.include import MarkdownInclude
# Markdown Extensions
markdown_include = MarkdownInclude(
configs={'base_path':'/srv/content/', 'encoding': 'iso-8859-1'}
)
html = markdown.markdown(source, extensions=[markdown_include])
```
Included files can inherit the heading depth of the location
``inheritHeadingDepth``, as well as receive a specific offset, ``headingOffset``
For example, consider the files
```markdown
Source file
# Heading Level 1 of main file
{!included_file.md!}
## Heading Level 2 of main file
{!included_file.md!}
```
and included_file.md
```markdown
# This heading will be one level deeper from the previous heading
More included file content.
End of included content.
```
Then running the script
```python
import markdown
from markdown_include.include import MarkdownInclude
# Markdown Extensions
markdown_include = MarkdownInclude(
configs={'inheritHeadingDepth':True}
)
html = markdown.markdown(source, extensions=[markdown_include])
```
produces
```html
<p>Source file</p>
<h1>Heading Level 1 of main file</h1>
<h2>This heading will be one level deeper from the previous heading</h2>
<p>More included file content.</p>
<p>End of included content.</p>
<h2>Heading Level 2 of main file</h2>
<h3>This heading will be one level deeper from the previous heading</h3>
<p>More included file content.</p>
<p>End of included content.</p>
```
## ChangeLog
### Version 0.7.0
Modified to work with Python-Markdown 3.4. This makes the plugin
incompatible with versions < 3.0.
### Version 0.6.0
- Added ability ot offset headers in the included file so they fall under the header level in which the include occurs
- Add option to throw exception when can't find an include file (instead of printing a warning)
- Fixed stripping of last character in file, so only occurs if it is a new-line
- Some behind-the-scenes improvement to code and documentation
### Version 0.5.1
Bugfix for a syntax error.
### Version 0.5
Corrected some errors in documentation and merged in commits of
[diegobz](https://github.com/diegobz) to add support for encoding and tidy up
the source code.
### Version 0.4
Fixed problem related to passing configurations to the extension.
### Version 0.3
Added support for Python 3.
### Version 0.2
Changed the API to be less likely to conflict with other syntax.
### Version 0.1
Initial release.
Raw data
{
"_id": null,
"home_page": "",
"name": "markdown-include",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Markdown,typesetting,include,plugin,extension",
"author": "",
"author_email": "Chris MacMackin <cmacmackin@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/ad/d8/66bf162fe6c1adb619f94a6da599323eecacf15b6d57469d0fd0421c10df/markdown-include-0.8.1.tar.gz",
"platform": null,
"description": "# Markdown-Include\n\nThis is an extension to [Python-Markdown](https://pythonhosted.org/Markdown/)\nwhich provides an \"include\" function, similar to that found in\nLaTeX (and also the C pre-processor and Fortran). I originally wrote it for my\n[FORD](https://github.com/cmacmackin/ford) Fortran auto-documentation generator.\n\n\n## Installation\nThis module can now be installed using ``pip``.\n\n pip install markdown-include\n\n## Tests\nUse the unittest module\n```bash\npython -m unittest discover unittests/\n```\n\n## Usage\nThis module can be used in a program in the following way:\n\n```python\nimport markdown\nhtml = markdown.markdown(source, extensions=['markdown_include.include'])\n```\n\nMarkdown-Include can also be included in MkDocs projects like below:\n\n```yaml\nmarkdown_extensions:\n - markdown_include.include:\n base_path: docs\n```\n\nThe syntax for use within your Markdown files is ``{!filename!}``. This\nstatement will be replaced by the contents of ``filename``. Markdown-Include\nwill work recursively, so any included files within ``filename`` will also be\nincluded. This replacement is done prior to any other\nMarkdown processing, so any Markdown syntax that you want can be used within\nyour included files. Note that this is a change from the previous version.\nIt was felt that this syntax was less likely to conflict with any code\nfragments present in the Markdown.\n\nBy default, all file-names are evaluated relative to the location from which\nMarkdown is being called. If you would like to change the directory relative to\nwhich paths are evaluated, then this can be done by specifying the extension\nsetting ``base_path``.\n\n### Line Ranges\n\nYou can also define specific lines or line ranges to include by specifying `lines`:\n\n```Markdown\n{!filename!lines=1 3 8-10 2}\n```\n\n`lines` takes a sequence of integers separated by spaces (one or more), or it can also\ntake line ranges specified with a start line and an end line separated by a dash (`-`).\n\nIn the example above, it would read the file called `filename` and include the lines\n`1`, `3`, `8`, `9`, `10`, `2`.\n\nNotice that line `9` was not explicitly set. But it was still included as part of the\nrange `8-10`.\n\nAlso, notice that line `2` is set *after* the range `8-10`. This means that the\nline `2` in `filename` will be included *after* (below) the range `8-10`.\n\nYou can use this to include lines in a different order than the original file. But it\nalso means that if you want to preserve the original order, you have to pay attention\nto the order in which you specify the lines.\n\n## Configuration\n\nThe following settings can be specified when initialising the plugin.\n\n- __base_path__: Default location from which to evaluate relative\n paths for the include statement. (Default: the run-directory.)\n- __encoding__: Encoding of the files used by the include statement. (Default: utf-8.)\n- __inheritHeadingDepth__ : If true, increases headings on include\n file by amount of previous heading. Combiens with headingOffset\n option, below. (Default: False.)\n- __headingOffset__: Increases heading depth by a specific ammount, in\n addition to the inheritHeadingDepth Option. (Default: 0)\n- __throwException__: When true, if the extension is unable to find an\n included file it will throw an exception which the user can\n catch. If false (default), a warning will be printed and Markdown\n will continue parsing the file.\n\n## Examples\n\nAn example of setting the base path and file encoding is given below:\n```python\nimport markdown\nfrom markdown_include.include import MarkdownInclude\n\n# Markdown Extensions\nmarkdown_include = MarkdownInclude(\n configs={'base_path':'/srv/content/', 'encoding': 'iso-8859-1'}\n)\nhtml = markdown.markdown(source, extensions=[markdown_include])\n```\n\nIncluded files can inherit the heading depth of the location\n``inheritHeadingDepth``, as well as receive a specific offset, ``headingOffset``\nFor example, consider the files\n```markdown\nSource file\n# Heading Level 1 of main file\n\n{!included_file.md!}\n\n## Heading Level 2 of main file\n\n{!included_file.md!}\n```\n\nand included_file.md\n\n```markdown\n# This heading will be one level deeper from the previous heading\nMore included file content.\nEnd of included content.\n```\nThen running the script\n```python\nimport markdown\nfrom markdown_include.include import MarkdownInclude\n\n# Markdown Extensions\nmarkdown_include = MarkdownInclude(\n configs={'inheritHeadingDepth':True}\n)\nhtml = markdown.markdown(source, extensions=[markdown_include])\n```\nproduces\n```html\n<p>Source file</p>\n<h1>Heading Level 1 of main file</h1>\n<h2>This heading will be one level deeper from the previous heading</h2>\n<p>More included file content.</p>\n<p>End of included content.</p>\n<h2>Heading Level 2 of main file</h2>\n<h3>This heading will be one level deeper from the previous heading</h3>\n<p>More included file content.</p>\n<p>End of included content.</p>\n```\n\n\n## ChangeLog\n### Version 0.7.0\nModified to work with Python-Markdown 3.4. This makes the plugin\nincompatible with versions < 3.0.\n### Version 0.6.0\n- Added ability ot offset headers in the included file so they fall under the header level in which the include occurs\n- Add option to throw exception when can't find an include file (instead of printing a warning)\n- Fixed stripping of last character in file, so only occurs if it is a new-line\n- Some behind-the-scenes improvement to code and documentation\n### Version 0.5.1\nBugfix for a syntax error.\n### Version 0.5\nCorrected some errors in documentation and merged in commits of\n[diegobz](https://github.com/diegobz) to add support for encoding and tidy up\nthe source code.\n### Version 0.4\nFixed problem related to passing configurations to the extension.\n### Version 0.3\nAdded support for Python 3.\n### Version 0.2\nChanged the API to be less likely to conflict with other syntax.\n### Version 0.1\nInitial release.\n",
"bugtrack_url": null,
"license": "GNU General Public License v3 (GPLv3)",
"summary": "A Python-Markdown extension which provides an 'include' function",
"version": "0.8.1",
"project_urls": {
"project": "https://github.com/cmacmackin/markdown-include"
},
"split_keywords": [
"markdown",
"typesetting",
"include",
"plugin",
"extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d7e2c4d20b21a05fe0fee571649cebc05f7f72e80b1a743f932e7326125e6c9e",
"md5": "6baec71ff932d4f5a418c5f53c7e9e6b",
"sha256": "32f0635b9cfef46997b307e2430022852529f7a5b87c0075c504283e7cc7db53"
},
"downloads": -1,
"filename": "markdown_include-0.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6baec71ff932d4f5a418c5f53c7e9e6b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 18837,
"upload_time": "2023-02-07T09:47:25",
"upload_time_iso_8601": "2023-02-07T09:47:25.030368Z",
"url": "https://files.pythonhosted.org/packages/d7/e2/c4d20b21a05fe0fee571649cebc05f7f72e80b1a743f932e7326125e6c9e/markdown_include-0.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "add866bf162fe6c1adb619f94a6da599323eecacf15b6d57469d0fd0421c10df",
"md5": "2bfd62c481bc04b3d61a4b14a2ba7c1b",
"sha256": "1d0623e0fc2757c38d35df53752768356162284259d259c486b4ab6285cdbbe3"
},
"downloads": -1,
"filename": "markdown-include-0.8.1.tar.gz",
"has_sig": false,
"md5_digest": "2bfd62c481bc04b3d61a4b14a2ba7c1b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 21873,
"upload_time": "2023-02-07T09:47:26",
"upload_time_iso_8601": "2023-02-07T09:47:26.608092Z",
"url": "https://files.pythonhosted.org/packages/ad/d8/66bf162fe6c1adb619f94a6da599323eecacf15b6d57469d0fd0421c10df/markdown-include-0.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-07 09:47:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cmacmackin",
"github_project": "markdown-include",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "markdown-include"
}
JSON
