Skip to main content

Preprocessor for Foliant doc maker that flattens a nested source tree into a single file. Required for Pandoc backend.

Project description

Project Flattener for Foliant

This preprocessor converts a Foliant project source directory into a single Markdown file containing all the sources, preserving order and inheritance.

This preprocessor is used by backends that require a single Markdown file as input instead of a directory. The Pandoc backend is one such example.

Installation

$ pip install foliantcontrib.flatten

Config

This preprocessor is required by Pandoc backend, so if you use it, you don’t need to install Flatten or enable it in the project config manually.

However, it’s still a regular preprocessor, and you can run it manually by listing it in preprocessors:

preprocessors:
    - flatten

The preprocessor has a number of options with the following default values:

preprocessors:
    - flatten:
        flat_src_file_name: __all__.md
        keep_sources: false

flat_src_file_name : Name of the flattened file that is created in the temporary working directory.

keep_sources : Flag that tells the preprocessor to keep Markdown sources in the temporary working directory after flattening. If set to false, all Markdown files excepting the flattened will be deleted from the temporary working directory.

Note

Flatten preprocessor uses Includes, so when you install Pandoc backend, Includes preprocessor will also be installed, along with Flatten.

Project details


Download files

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

Files for foliantcontrib.flatten, version 1.0.7
Filename, size File type Python version Upload date Hashes
Filename, size foliantcontrib.flatten-1.0.7-py3-none-any.whl (4.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size foliantcontrib.flatten-1.0.7.tar.gz (3.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page