https://github.com/foliant-docs/foliantcontrib.removeexcess
Preprocessor for Foliant to remove unnecessary files that are not mentioned in chapters.
https://github.com/foliant-docs/foliantcontrib.removeexcess
Last synced: 5 months ago
JSON representation
Preprocessor for Foliant to remove unnecessary files that are not mentioned in chapters.
- Host: GitHub
- URL: https://github.com/foliant-docs/foliantcontrib.removeexcess
- Owner: foliant-docs
- License: mit
- Created: 2020-04-24T10:47:28.000Z (about 6 years ago)
- Default Branch: develop
- Last Pushed: 2020-04-24T10:49:27.000Z (about 6 years ago)
- Last Synced: 2025-09-18T07:34:51.324Z (9 months ago)
- Language: Python
- Size: 2.93 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RemoveExcess
RemoveExcess is a preprocessor that removes unnecessary Markdown files that are not mentioned in the project’s `chapters`, from the temporary working directory.
## Installation
```bash
$ pip install foliantcontrib.removeexcess
```
## Config
To enable the preprocessor, add `removeexcess` to `preprocessors` section in the project config:
```yaml
preprocessors:
- removeexcess
```
The preprocessor has no options.
## Usage
By default, all preprocessors are applied to each Markdown source file copied into the temporary working directory.
Often it’s needed not to include some files to the project’s `chapters`. But anyway, preprocessors will be applied to all source files, that will take extra time and may cause extra errors. Also, extra files may pass to backends that might be undesirable for security reasons.
When RemoveExcess preprocessor is enabled, unnecessary files will be deleted. Decide at your discretion to which place in the preprocessor queue to put it.