| Crates.io | handlebars-magic |
| lib.rs | handlebars-magic |
| version | 0.6.0 |
| created_at | 2021-05-05 21:46:24.329317+00 |
| updated_at | 2024-04-21 13:16:11.615458+00 |
| description | Quickly and flexibly generate content based on handlebars templates. |
| homepage | https://github.com/rust-utility/handlebars-magic |
| repository | https://github.com/rust-utility/handlebars-magic |
| max_upload_size | |
| id | 393606 |
| size | 45,705 |
Dual-licensed under MIT or the UNLICENSE.
cargo install handlebars-magic
Generates documentation from handlebars templates
Usage: handlebars-magic <INPUT> <OUTPUT>
Arguments:
<INPUT> The input folder with templates
<OUTPUT> The output folder
Options:
-h, --help Print help
-V, --version Print version
For each file in the input folder, a corresponding file will be created in the output folder.
For example, this project generates updated documentation using the following call:
handlebars-magic templates .
fromSearches for the prefix and starts with it if it is found. Otherwise, the entire string is returned.
{{ from "begin" "prefix begin text end" }}
renders to:
begin text end
toSearches for the prefix and starts with it if it is found. Otherwise, the entire string is returned.
{{ to ")" "hello)" }}
renders to:
hello
renderProcesses an argument as handlebars's template.
{{ render "some handlebars template" }}
renders to:
some handlebars template
This does not look useful until we use it in conjuction with other helper such as read_to_str from handlebars_misc_helpers:
{{ render ( read_to_str "templates/README.md" ) }}
codeblockAllows to insert markdown's fenced code block. Content would be trimmed.
{{ codeblock "bash" "echo test" }}
renders to:
```bash
echo test
```
execAllows to include output of command.
{{ exec "echo test" }}
renders to:
test
handlebars_misc_helpersAll helpers from handlebars_misc_helpers.