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

```shell
$ 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`:


```yaml
preprocessors:
- flatten
```

The preprocessor has only one option—`flat_src_file_name`. It's the name of the flattened file that is created in the tmp directory:

```yaml
preprocessors:
- flatten:
flat_src_file_name: flattened.md
```

Default value is `__all__.md`.

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

Filename, size & hash SHA256 hash help File type Python version Upload date
foliantcontrib.flatten-1.0.4.tar.gz (2.7 kB) Copy SHA256 hash SHA256 Source None Aug 31, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page