开源软件名称(OpenSource Name):cmacmackin/markdown-include开源软件地址(OpenSource Url):https://github.com/cmacmackin/markdown-include开源编程语言(OpenSource Language):Python 100.0%开源软件介绍(OpenSource Introduction):Markdown-IncludeThis is an extension to Python-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 Fortran auto-documentation generator. InstallationThis module can now be installed using
UsageThis module can be used in a program in the following way: import markdown
html = markdown.markdown(source, extensions=['markdown_include.include']) The syntax for use within your Markdown files is 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 ConfigurationThe following settings can be specified when initialising the plugin.
ExamplesAn example of setting the base path and file encoding is given below: 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
Source file
# Heading Level 1 of main file
{!included_file.md!}
## Heading Level 2 of main file
{!included_file.md!} and included_file.md # This heading will be one level deeper from the previous heading
More included file content.
End of included content. Then running the script import markdown
from markdown_include.include import MarkdownInclude
# Markdown Extensions
markdown_include = MarkdownInclude(
configs={'inheritHeadingDepth':True}
)
html = markdown.markdown(source, extensions=[markdown_include]) produces <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> ChangeLogVersion 0.7.0Modified to work with Python-Markdown 3.4. This makes the plugin incompatible with versions < 3.0. Version 0.6.0
Version 0.5.1Bugfix for a syntax error. Version 0.5Corrected some errors in documentation and merged in commits of diegobz to add support for encoding and tidy up the source code. Version 0.4Fixed problem related to passing configurations to the extension. Version 0.3Added support for Python 3. Version 0.2Changed the API to be less likely to conflict with other syntax. Version 0.1Initial release. |
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
请发表评论