blogs-md-easy

Crates.io	blogs-md-easy
lib.rs	blogs-md-easy
version	0.3.8
source	src
created_at	2024-03-20 21:06:10.132153
updated_at	2024-04-23 20:12:26.736884
description	Iteratively convert a collection of Markdown files into a respective HTML template.
homepage	https://github.com/BritishWerewolf/blogs-md-easy
repository	https://github.com/BritishWerewolf/blogs-md-easy
max_upload_size
id	1180982
size	130,847

(BritishWerewolf)

documentation

https://docs.rs/crate/blogs-md-easy

README

Blogs Made Easy

Iteratively convert a collection of Markdown files into a respective HTML template.

Installation

Blogs Made Easy is available as both a binary and a library, both from this package.

In both cases, ensure that you have cargo installed.

Binary

Open your Terminal, and run the following command.

$ cargo install blogs-md-easy

Library

Update your Cargo.toml by running the following command.

$ cargo add blogs-md-easy

Usage

Below is the help page for the program binary, if you want to read the documentation for the library, that is available on docs.rs.

Iteratively convert a collection of Markdown files into a respective HTML template.

Usage: blogs-md-easy.exe [OPTIONS] --templates <FILES>... --markdowns <FILES>...

Options:
  -t, --templates <FILES>...  HTML template that the Markdowns will populate
  -m, --markdowns <FILES>...  List of Markdown files ending in .md
  -o, --output-dir <DIR>      Output directory, defaults to the Markdown's directory
  -a, --allow <RULES>...      Define an allow list for features
  -h, --help                  Print help
  -V, --version               Print version

Templates

Templates are .html files that use variables to populate the file.

If more than a single template is provided, then the file stem will be used in the name of the output file. This is to avoid each template generating a new HTML file and overwriting previous files.
In the case that a single template is used, the output file name will simple be the Markdown file with the extension of .html instead of .md.

Variables must follow these rules:

Must be wrapped in {{ and }}, white space either side is optional.
Must be prefixed with a £ or $ character.
Must start with a letter from a to z, case insensitive.
Must only contain the following characters: a-z, 0-9, _.

Two variables are required: title and content.
More on how these variables are parsed in the below section.

Example of a valid template page.

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="description" content="{{ £description }}">

    <title>{{ £title }}</title>
</head>
<body>
    <section>
        <h1>{{ £title }}</h1>
        <p>Authored by {{ £author }}</p>
    </section>
    <section>{{ £content }}</section>
</body>
</html>

Firstly, there is a £description variable that is used for the meta description tag.
This will be provided within the meta section of each Markdown file, as will the £author variable.

Additionally, the £title variable is used in two locations: for the document title, and as a heading.
Variables can be reused as many times as required, and will be replaced, providing they follow the above rules.

Finally, the £content variable is automatically generated based on the entire body of the Markdown file.

Filters

It's possible to mutate the placeholders during rendering by providing filters.
A filter is just a way of applying a pre-defined function to any placeholder variable.

Let's use our previous template, and apply a simple filter to the £title variable.

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="description" content="{{ £description }}">

    <title>{{ £title }}</title>
</head>
<body>
    <section>
        <h1>{{ £title | uppercase }}</h1>
        <p>Authored by {{ £author }}</p>
    </section>
    <section>{{ £content }}</section>
</body>
</html>

By providing the function after a pipe (|) character, we can mutate that variable in that particular location. This is particularly useful in cases where a placeholder is required multiple times through a template, but the formatting should be different in all cases.

These are currently the only supported filters; with their arguments, if available.
We'll talk about arguments later on, but for now, know that the argument name is optional and only a value is required.

lowercase - Convert the value to lowercase.
uppercase - Convert the value to uppercase.
markdown - Convert the value from Markdown into HTML.
reverse - Reverse the string order.
truncate - Truncate the value to the given length, and adds trailing character(s) if the string is truncated.
- characters - default - The number of characters to limit a string to.
- trail - The character(s) to add to the end of the string if it is truncated.

By default, no filters will be provided, unless specified within the template, with the exception of £content which will have markdown applied.

Filters are case insensitive, meaning | uppercase is the same as | UPPERCASE. They can also be chained together, such as in the following example.

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="description" content="{{ £description }}">

    <title>{{ £title }}</title>
</head>
<body>
    <section>
        {{ £title | uppercase | markdown }}
        <p>Authored by {{ £author }}</p>
    </section>
    <section>{{ £content }}</section>
</body>
</html>

Here we are converting the title to uppercase, and then mutating the value into markdown.
Chained filters are evaluated from left to right.

Filters with arguments

For some filters, there are optional arguments that can be provided. This is done through a comma separated list after an equals (=) sign.
Every filter can be provided with just the name, as every argument has been given a default value.

What that means, is that these are all the same thing.

<p>{{ £my_paragraph | truncate }}</p>
<p>{{ £my_paragraph | truncate = 20 }}</p>
<p>{{ £my_paragraph | truncate = trail: ... }}</p>
<p>{{ £my_paragraph | truncate = characters: 20, trail: ... }}</p>

As you can see, you can pick and choose which arguments you want to overwrite - if any.

You'll have also noticed that in the second example we didn't provide a key!
This is because, for each filter that takes arguments, one argument will be considered the "default" argument. As a result, if you provide a value, with no argument name, then this will be set to the pre-determined default argument for that filter.

Markdowns

Markdowns are simple text files that contain any text, and an optional meta section.

The meta section of the Markdown file is unique to this program.
This section must be at the top of the document, and will be start with either :meta or <meta>, and closed with :meta or </meta>.
It's important that if you open the meta section with :meta, then you must close it with :meta; the same is true for <meta> and </meta> otherwise the content won't be read.

Use the meta section to provide the template values for the variables that have been defined. As a result, the variables used in the meta section must adhere to the rules that apply to the template variables.

A warning will be generated if a variable is declared in the Markdown, but not used.
Conversely, an error will cause the execution of the program to stop if the template doesn't receive values for all variables.

There is no requirement to declare the meta section; however if you do not provide an <h1> (the Markdown # is acceptable too) at the top of your content, then a title variable is required.

Example of a Markdown file, where the title is parsed from the document.

:meta
author = John Doe
description = This will appear in Search Engines.
:meta
# Markdown Title
This is the content of our file.

Using the above template, would generate the following output.

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="description" content="This will appear in Search Engines.">

    <title>Markdown Title</title>
</head>
<body>
    <section>
        <h1>Markdown Title</h1>
        <p>Authored by John Doe</p>
    </section>
    <section>
        <h1>Markdown Title</h1>
        <p>This is the content of our file.</p>
    </section>
</body>
</html>

Another example where we overwrite the title variable and use the prefix.

<meta>
£author = John Doe
£title = Meta Title
£description = This will appear in Search Engines.
</meta>
# Markdown Title
This is the content of our file.

Which would generate the following output

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="description" content="This will appear in Search Engines.">

    <title>Meta Title</title>
</head>
<body>
    <section>
        <h1>Meta Title</h1>
        <p>Authored by John Doe</p>
    </section>
    <section>
        <h1>Markdown Title</h1>
        <p>This is the content of our file.</p>
    </section>
</body>
</html>

For convenience, meta values do not need to be surrounded by quotes, they will be parsed until a new line. However, if new lines are required in a value, then the value will need to be surrounded by double quotes (").
As is standard, quotes will need to be escaped in order to prevent premature closure of the string; to do this, simply put a backslash before a double quote, like so \".

:meta
header = Some Company
footer = "Copyright
John \"The Mystery\" Doe"
:meta

Comments

It's possible to add comments to the meta section, by starting a line with either # or //.
Comments will be parsed and the leading comment prefix will be removed, however this is superfluous as they will be replaced with None during parsing, and subsequently removed.

:meta
// This is a comment.
author = John Doe
# This is another type of comment
description = This will appear in Search Engines.
:meta

The above meta key-values that would be parsed would be author and description, with the values being John Doe and This will appear in Search Engines. respectively.

Output

All HTML files will be generated with the exact same name as the Markdown that they are converting, but with the template's extension.

By default, the file will be created in the same directory as the Markdown file, however, by providing --output-dir (or -o if that's easier) the output directory can be changed.
This will not rename the file, but rather just place it in the specified directory.

Some formatting will be applied to the generated output, but it will likely need human intervention if you want the document to be formatted correct - such as indenting.
Currently, a new line is placed before all headings (from h2 to to h6), but nothing else is changed.

Allow List

In some cases, this program will report warnings.

These do not prevent the program from running, but will simply print the warning to the console.
An example of this is unused variables.

Consider if we had a Markdown file that declared the key-value pair of author = John Doe, and then never referenced that variable in the template, then ordinarily the template would still be created but we'd have a warning in the console like this.

Warning: Unused variable in 'path/to/file.md': author

If you do not wish for this message to be printed, you can use the following commands.

blogs-md-easy -m path/to/file.md -t path/to/template.html --allow unused
blogs-md-easy -m path/to/file.md -t path/to/template.html --allow unused_variables

Commit count: 63