ImagineUI integration preprocessor for Foliant.
Project description
ImagineUI for Foliant
ImagineUI is a tool that supports developing wireframes in a localized human-readable format.
This preprocessor allows using <imagineui>
macros in Foliant
Installation
Before using ImagineUI, you need to install Node.js.
ImagineUI preprocessor code is written in Python, but it uses a JavaScript package. This script is provided in ImagineUI package:
$ pip install foliantcontrib.imagineui
ImagineUI uses Puppeteer for rendering in background, which is a huge dependency, so to avoid downloading Chrome every time this preprocessor applies, it's advised to install imagineui-cli
globally.
$ npm i -g imagineui-cli
Config
To enable the preprocessor, add imagineui
to preprocessors
section in the project config:
preprocessors:
- imagineui
The preprocessor has a number of options with the following default values:
preprocessors:
- imagineui:
version: global
cache_dir: !path .imagineuicache
version
: Version of the imagineui-cli
package in NPM. "global" (default) will skip and will use either the version already installed globally or the latest version, which speeds up NPX significantly.
cache_dir
: Directory to store downloaded and resized images.
Usage
To insert a wireframe image rendered by ImagineUI into your documentation, use <imagineui>...</imagineui>
tags in Markdown source:
<imagineui>
Page: "Welcome screen"
Block: "Header"
Header "Mockup poetry"
Block: "Flowers"
Two columns
Image "Roses are red,"
Image "Violets are blue."
Image "Your mockups are awesome,"
Image "And so are you!"
Block: "Footer"
One row
Button "Try ImagineUI"
Button "Subscribe"
Button "Contribute"
</imagineui>
ImagineUI preprocessor will replace such blocks with local image references.
Acknowledgements
BindSympli preprocessor was used as a starting point
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 Distributions
Hashes for foliantcontrib.imagineui-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 676a12fe27864be87488cbc8bcd4e78d3d31c47299e246aa1c590af0273ba480 |
|
MD5 | 9f56a1e547b64a9e2c6dee4542beb16b |
|
BLAKE2b-256 | fc9edcda0690732ab61c8c7eb83e9dc5fb9d4bfaa69979afe4e2f8a6d8c839b3 |
Hashes for foliantcontrib.imagineui-1.0.0-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2bef336b84096f6820c17d037d8e4d211ec8a8b47897ffcbb5c34d1911f5df78 |
|
MD5 | d5f4c48f35b0490f0bc5adc3971e6ade |
|
BLAKE2b-256 | e3928409c840a02bdbc7e389430840b83fa7e8109eec0f4837c8d9171ba85d29 |
Hashes for foliantcontrib.imagineui-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a4abfa37ba198b312a1f652d47be293790fa13a5cd5c7235b97dc8313c596d9 |
|
MD5 | 19324d74a25b4745a9f2350f6587a1d2 |
|
BLAKE2b-256 | 8f7a2404df9be0b029094953b6000ef1d635cf95d8cef4e8327d23414d891300 |