Create Foliant projects from templates.
Project description
# Project Initializer for Foliant
This CLI extension add `init` command that lets you create Foliant projects from templates.
## Installation
```shell
$ pip install foliantcontrib.init
```
## Usage
Create project from the default “basic” template:
```shell
$ foliant init
Enter the project name: Awesome Docs
✔ Generating Foliant project
─────────────────────
Project "Awesome Docs" created in /path/to/awesome-docs
```
Create project from a custom template:
```shell
$ foliant init --template /path/to/custom/template
Enter the project name: Awesome Customized Docs
✔ Generating Foliant project
─────────────────────
Project "Awesome Customized Docs" created in /path/to/awesome-customized-docs
```
You can provide the project name without user prompt:
```shell
$ foliant init --name Awesome Docs
✔ Generating Foliant project
─────────────────────
Project "Awesome Docs" created in /path/to/awesome-docs
```
Another useful option is `--quiet`, which hides all output except for the path to the generated project:
```shell
$ foliant init --name Awesome Docs --quiet
/path/to/awesome-docs
```
To see all available options, run `foliant init --help`:
```shell
$ foliant init --help
usage: foliant init [-h] [-n NAME] [-t NAME or PATH] [-q]
Generate new Foliant project.
optional arguments:
-h, --help show this help message and exit
-n NAME, --name NAME Name of the Foliant project
-t NAME or PATH, --template NAME or PATH
Name of a built-in project template or path to custom one
-q, --quiet Hide all output accept for the result. Useful for piping.
```
## Project Templates
A project template is a regular Foliant project but containing placeholders in files. When the project is generated, the placeholders are replaced with the values you provide. Currently, there are two placeholders: `{title}` and `{slug}`.
There is a built-in template called `basic`. It's used by default if no template is specified.
This CLI extension add `init` command that lets you create Foliant projects from templates.
## Installation
```shell
$ pip install foliantcontrib.init
```
## Usage
Create project from the default “basic” template:
```shell
$ foliant init
Enter the project name: Awesome Docs
✔ Generating Foliant project
─────────────────────
Project "Awesome Docs" created in /path/to/awesome-docs
```
Create project from a custom template:
```shell
$ foliant init --template /path/to/custom/template
Enter the project name: Awesome Customized Docs
✔ Generating Foliant project
─────────────────────
Project "Awesome Customized Docs" created in /path/to/awesome-customized-docs
```
You can provide the project name without user prompt:
```shell
$ foliant init --name Awesome Docs
✔ Generating Foliant project
─────────────────────
Project "Awesome Docs" created in /path/to/awesome-docs
```
Another useful option is `--quiet`, which hides all output except for the path to the generated project:
```shell
$ foliant init --name Awesome Docs --quiet
/path/to/awesome-docs
```
To see all available options, run `foliant init --help`:
```shell
$ foliant init --help
usage: foliant init [-h] [-n NAME] [-t NAME or PATH] [-q]
Generate new Foliant project.
optional arguments:
-h, --help show this help message and exit
-n NAME, --name NAME Name of the Foliant project
-t NAME or PATH, --template NAME or PATH
Name of a built-in project template or path to custom one
-q, --quiet Hide all output accept for the result. Useful for piping.
```
## Project Templates
A project template is a regular Foliant project but containing placeholders in files. When the project is generated, the placeholders are replaced with the values you provide. Currently, there are two placeholders: `{title}` and `{slug}`.
There is a built-in template called `basic`. It's used by default if no template is specified.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for foliantcontrib.init-1.0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ecf9ac104e417886d5df567102b4fb6f4c0c23b3d603d1310caccd52a21f9145 |
|
MD5 | ae58da61249404eea0728e59824e154d |
|
BLAKE2b-256 | d42d586293b3643eb59477d9d94edb6e8ced8ed3c2860ba6a307ab1fa90a3b8a |
Close
Hashes for foliantcontrib.init-1.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f9955f4dde59222578f481640a2cb775e214ed0ca1f732670cacaf51c3cd428 |
|
MD5 | 8f7cca6012eafe7a9483359182b949d1 |
|
BLAKE2b-256 | 68f149799ca851e7bd0dce8f5e30e4b25056a5512c1cc6d4a3b859d993b387df |