https://github.com/foliant-docs/foliantcontrib.templates.preprocessor
Preprocessor template for `foliant init` command.
https://github.com/foliant-docs/foliantcontrib.templates.preprocessor
Last synced: 5 months ago
JSON representation
Preprocessor template for `foliant init` command.
- Host: GitHub
- URL: https://github.com/foliant-docs/foliantcontrib.templates.preprocessor
- Owner: foliant-docs
- License: mit
- Created: 2018-04-19T09:12:28.000Z (about 8 years ago)
- Default Branch: develop
- Last Pushed: 2018-11-23T10:04:07.000Z (over 7 years ago)
- Last Synced: 2025-09-28T00:23:00.209Z (9 months ago)
- Language: Python
- Size: 12.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# Preprocessor Template for `foliant init` Command
Template for a Foliant preprocessor. Instead of looking for an existing preprocessor, cloning it, and modifying its source, install this package and generate a preprocessor directory. As simple as:
```shell
$ foliant init -t preprocessor
```
## Installation
```shell
$ pip install --no-compile foliantcontrib.templates.preprocessor
```
## Usage
```shell
$ foliant init -t preprocessor
Enter the project name: Awesome Preprocessor
✔ Generating project
─────────────────────
Project "Awesome Preprocessor" created in awesome-preprocessor
```
Or:
```shell
$ foliant init -t preprocessor -n "Awesome Preprocessor"
✔ Generating project
─────────────────────
Project "Awesome Preprocessor" created in awesome-preprocessor
```
Result:
```shell
$ tree awesome-preprocessor
.
├── changelog.md
├── foliant
│ └── preprocessors
│ └── awesome-preprocessor.py
├── LICENSE
├── README.md
└── setup.py
2 directories, 5 files
```