Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cmacmackin/markdown-include

Provides syntax for Python-Markdown which allows for the inclusion of the contents of other Markdown documents.
https://github.com/cmacmackin/markdown-include

Last synced: 9 days ago
JSON representation

Provides syntax for Python-Markdown which allows for the inclusion of the contents of other Markdown documents.

Host: GitHub
URL: https://github.com/cmacmackin/markdown-include
Owner: cmacmackin
License: gpl-3.0
Created: 2015-01-09T01:12:35.000Z (almost 10 years ago)
Default Branch: master
Last Pushed: 2024-05-10T07:24:10.000Z (6 months ago)
Last Synced: 2024-10-02T10:47:32.746Z (about 1 month ago)
Language: Python
Size: 79.1 KB
Stars: 102
Watchers: 9
Forks: 41
Open Issues: 13
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

# 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