From 40109fb2cca8c22cb3b11a68da6e0493eaba28e5 Mon Sep 17 00:00:00 2001 From: Peter Hill Date: Wed, 23 Nov 2022 17:25:46 +0000 Subject: [PATCH] Delete outdated README.rst file --- README.rst | 54 ------------------------------------------------------ 1 file changed, 54 deletions(-) delete mode 100644 README.rst diff --git a/README.rst b/README.rst deleted file mode 100644 index 44d1744..0000000 --- a/README.rst +++ /dev/null @@ -1,54 +0,0 @@ -Markdown-Include -================ - -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. 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``. - -:: - - 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]) -