Skip to main content

This is an extension to Python-Markdown which provides an

Project description

This 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.

Installation

This module can now be installed using pip.

pip install markdown-include

Usage

This 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 {{filename}}. This statement will be replaced by the contents of filename. Markdown-Include will work recursively, so any included files within filename wil 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.

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_dir.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

markdown-include-0.1.tar.gz (3.7 kB view details)

Uploaded Source

File details

Details for the file markdown-include-0.1.tar.gz.

File metadata

File hashes

Hashes for markdown-include-0.1.tar.gz
Algorithm Hash digest
SHA256 c9a959a33c4670d953da6cfa5ba73e7a52cc04428cd83a09e9e67f96c7c0e848
MD5 f219940967a55a1f0fb7c954ae4ca8a0
BLAKE2b-256 22bed5f5542745d471f61941b09c1e3278fd1fd9342eed74a70f82002314de53

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page