Static HTML template engine.
Project description
Templix
A static HTML templating engine. Suitable for github pages and other static sites.
All code is ran at build time.
Usage
Install via pipx install templix, then use templix to build.
A default config file will be created with the following contents:
{"source": "src", "output": "build"}
Running templix will build src/index.md. Any files used by it will be included in the build.
Syntax
Normal markdown will be parsed in .md files.
You are supposed to write reusable .html file templates
that you then use in your .md files.
Python code blocks
You can use {{ <code> }} to embed the result of running python code.
If the opening and closing braces are on the same line eval() will be used and the block will be replaced by the evaluation result
Otherwise it will be replaced by the value of the emitted result variable.
Example:
Single line
<title>{{ title }}</title>
Multiline
<p>
{{
result = ''
for i in range(25):
result += f'Hello, {i}\n'
}}
</p>
Special blocks
You can use {% <special> %} for if, for and import statements.
End a block with a {% end %}.
If statements
If the condition is false the contents of the block is skipped. Otherwise the block will be replaced by its contents.
Example:
{% if title %}
<title>{{ title }}</title>
{% end %}
For statements
The block will be repeated for every element in the evaluated result.
Example:
{% for page in pages %}
<h2>{{ page.rsplit('.',1)[0].capitalize() }}</h2>
<p>{{ open(page).read() }}</p>
<br>
{% end %}
Pages definition (example)
pages = [
'page1.md',
'page2.md',
'page3.md',
'page4.md',
'page5.md'
]
Import statements
Identical to a python code block. Imports the module and stores it in vars.
Example:
Automatically includes files from a folder.
{% import os %}
{% for i in os.listdir("pages") %}
{{ open(os.path.join("pages", i)).read() }}
{% end %}
Preprocessor syntax
@using declaration
With @using <file> you can embed the current file in between content in <file>.
The content of the file will be passed into <file> as the content variable.
@include declaration
With @include <file> you can embed <file> into the current file.
The declaration is replaced with the file contents.
Argument declarations
Using $<key> <value>, you can pass arguments to
the @using or @include declarations.
They will be available in the file as normal variables.
The space before the $ is not required but without it
the syntax highlight will break.
The value is parsed as everything on the same line after the declaration. It is passed as a string.
Example:
Proper .html boilerplate.
index.md
@using base.html
$title Hello, World
# Hello, World!
This is an example!
@include content.html
base.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
{% if title %}
<title>{{ title }}</title>
{% end %}
</head>
<body>
{{ content }}
</body>
</html>
content.html
<h2>Lorem ipsum dolor sit amet,</h2>
<p>
consectetur adipiscing elit.
Vivamus tempus mauris vel ex congue porta. Integer elementum,
purus sed convallis fermentum, ipsum est pellentesque dui,
eget viverra ligula felis ut nisi. Duis pellentesque felis
quis tellus aliquam, non pretium erat interdum. Fusce ut
pulvinar urna. Proin venenatis congue commodo. Nullam metus mi,
posuere a nulla vitae, tincidunt blandit erat. Nulla imperdiet
massa ut semper facilisis.
</p>
Builtin functions
All python builtins are available, additionally, templix provides two additional builtin funcions.
include(file:str, **kwargs)
Same as the @include declaration. Fetches the file, parses it and returns it.
You can provide variables to the file via **kwargs.
url(file)
Returns a url to the target file. Automatically replaces .md with .html.
Additionally pointing this to a non-html file will copy that file over.
This is very useful for linking to scripts or stylesheets.
Example:
<!-- Stylesheet -->
<link rel="stylesheet" href="{{ url('style.css') }}">
<!-- Script -->
<script src="{{ url('script.js') }}"></script>
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file templix-1.1.0.tar.gz.
File metadata
- Download URL: templix-1.1.0.tar.gz
- Upload date:
- Size: 11.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
279a661549d5d5d7a7e52c5b1cfc7db1c02437f01820fa248467cc01664736c5
|
|
| MD5 |
f08e24e10cdee7d8704d09d287e829bc
|
|
| BLAKE2b-256 |
0f90549792f21d4bf152817fd8c60269aa13d6b81252a7381d468e5bb5905264
|
Provenance
The following attestation bundles were made for templix-1.1.0.tar.gz:
Publisher:
publish.yml on Omena0/templix
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
templix-1.1.0.tar.gz -
Subject digest:
279a661549d5d5d7a7e52c5b1cfc7db1c02437f01820fa248467cc01664736c5 - Sigstore transparency entry: 1396747786
- Sigstore integration time:
-
Permalink:
Omena0/templix@1d13cc21fd073b37a50d93febcd7e8251758bd6e -
Branch / Tag:
refs/heads/main - Owner: https://github.com/Omena0
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@1d13cc21fd073b37a50d93febcd7e8251758bd6e -
Trigger Event:
push
-
Statement type:
File details
Details for the file templix-1.1.0-py3-none-any.whl.
File metadata
- Download URL: templix-1.1.0-py3-none-any.whl
- Upload date:
- Size: 10.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a31be07dd76ae2b0cd106f1e4032fc37a866ec4b70d976d45be2381fbf1a5642
|
|
| MD5 |
b6319d4a97606267be2d6768c45f6018
|
|
| BLAKE2b-256 |
3f0d4ab938727207813ba2ac6cce7230e564184c3417e7a1e8f5f2c971d6176c
|
Provenance
The following attestation bundles were made for templix-1.1.0-py3-none-any.whl:
Publisher:
publish.yml on Omena0/templix
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
templix-1.1.0-py3-none-any.whl -
Subject digest:
a31be07dd76ae2b0cd106f1e4032fc37a866ec4b70d976d45be2381fbf1a5642 - Sigstore transparency entry: 1396747801
- Sigstore integration time:
-
Permalink:
Omena0/templix@1d13cc21fd073b37a50d93febcd7e8251758bd6e -
Branch / Tag:
refs/heads/main - Owner: https://github.com/Omena0
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@1d13cc21fd073b37a50d93febcd7e8251758bd6e -
Trigger Event:
push
-
Statement type:
