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.
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.
Source Distribution
Close
Hashes for foliantcontrib.flatten-1.0.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0bfc3f9207468b54dd0cebe48b106579765feead806108fad3de137c64a92923 |
|
MD5 | 21ce880a1cb481ca52dc406f18c4b164 |
|
BLAKE2b-256 | 3487981896264c66bd0d51f3e4cfc3d57952a3296418c6888c6eb2b204173d7b |