Extension for Foliant documentation tool to include YAML-files in config and xml-tag parameters.
Project description
YAMLInclude Extension
YAMLInclude is a configuration extension for Foliant to include parts of configuration from YAML-files.
It resolves !include
YAML tag in the project config and inside XML-tags parameters.
Installation
$ pip install foliantcontrib.yaml_include
Usage
The syntax of the !include
YAML tag is:
!include <file>[#<key>]
Where file
may be
- path to local file in Foliant project root,
- direct link to a file on remote server.
An optional #<key>
part is used to get a key from the mapping stored inside <file>
.
Including a local file
Config example:
chapters: !include chapters.yml
In this example the chapters.yml
file should be placed in your Foliant project root.
if the contents of chapters.yml
are as follows:
# chapters.yml
- index.md
- description.md
then the resulting config after applying the extension will be:
chapters:
- index.md
- description.md
Including part of a local file
Config example:
chapters: !include chapters.yml#chapters_for_pdf
In this example the chapters.yml
file should be placed in your Foliant project root.
if the contents of chapters.yml
are as follows:
# chapters.yml
chapters_for_site:
- index_site.md
- description_site.md
chapters_for_pdf:
- index.md
- description.md
then the resulting config after applying the extension will be:
chapters:
- index.md
- description.md
Including a remote file
Config example:
chapters: !include http://example.com/chapters.yml
In this example the chapters.yml
file is stored on the website http://example.com/
.
if the contents of chapters.yml
are as follows:
# chapters.yml
- index.md
- description.md
then the resulting config after applying the extension will be:
chapters:
- index.md
- description.md
Including part of a remote file
Config example:
chapters: !include http://example.com/chapters.yml#chapters_for_pdf
In this example the chapters.yml
file is stored on the website http://example.com/
.
if the contents of chapters.yml
are as follows:
# chapters.yml
chapters_for_site:
- index_site.md
- description_site.md
chapters_for_pdf:
- index.md
- description.md
then the resulting config after applying the extension will be:
chapters:
- index.md
- description.md
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
Hashes for foliantcontrib.yaml_include-1.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b86c770724870483bfff48e65b45bf1a7cc604a7e574bce9b1d5e98193b5965b |
|
MD5 | bbeab1586a704bbbf597dad78772cfed |
|
BLAKE2b-256 | 0068e7a96397063e768b5a4987182b02c00cd9c2bff4f91f0db50dcc9caa922b |
Hashes for foliantcontrib.yaml_include-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f00db5344acc9f8c81dff4b85c6f3121d678e683b3e487edc9c96f17e549970 |
|
MD5 | 622d8d71319c62ee09f355afc6904f12 |
|
BLAKE2b-256 | 95ed13056c7cb5b51a265713f344ab5fac0bf5eb192bf99c3f4cbfa34b3beaff |