Metadata-Version: 2.4
Name: templix
Version: 1.1.0
Summary: Static HTML template engine.
Author: Omena0
License: 
        # PolyForm Noncommercial License 1.0.0
        
        <https://polyformproject.org/licenses/noncommercial/1.0.0>
        
        ## Acceptance
        
        In order to get any license under these terms, you must agree
        to them as both strict obligations and conditions to all
        your licenses.
        
        ## Copyright License
        
        The licensor grants you a copyright license for the
        software to do everything you might do with the software
        that would otherwise infringe the licensor's copyright
        in it for any permitted purpose.  However, you may
        only distribute the software according to [Distribution
        License](#distribution-license) and make changes or new works
        based on the software according to [Changes and New Works
        License](#changes-and-new-works-license).
        
        ## Distribution License
        
        The licensor grants you an additional copyright license
        to distribute copies of the software.  Your license
        to distribute covers distributing the software with
        changes and new works permitted by [Changes and New Works
        License](#changes-and-new-works-license).
        
        ## Notices
        
        You must ensure that anyone who gets a copy of any part of
        the software from you also gets a copy of these terms or the
        URL for them above, as well as copies of any plain-text lines
        beginning with `Required Notice:` that the licensor provided
        with the software.  For example:
        
        > Required Notice: Copyright Yoyodyne, Inc. (<http://example.com>)
        
        ## Changes and New Works License
        
        The licensor grants you an additional copyright license to
        make changes and new works based on the software for any
        permitted purpose.
        
        ## Patent License
        
        The licensor grants you a patent license for the software that
        covers patent claims the licensor can license, or becomes able
        to license, that you would infringe by using the software.
        
        ## Noncommercial Purposes
        
        Any noncommercial purpose is a permitted purpose.
        
        ## Personal Uses
        
        Personal use for research, experiment, and testing for
        the benefit of public knowledge, personal study, private
        entertainment, hobby projects, amateur pursuits, or religious
        observance, without any anticipated commercial application,
        is use for a permitted purpose.
        
        ## Noncommercial Organizations
        
        Use by any charitable organization, educational institution,
        public research organization, public safety or health
        organization, environmental protection organization,
        or government institution is use for a permitted purpose
        regardless of the source of funding or obligations resulting
        from the funding.
        
        ## Fair Use
        
        You may have "fair use" rights for the software under the
        law. These terms do not limit them.
        
        ## No Other Rights
        
        These terms do not allow you to sublicense or transfer any of
        your licenses to anyone else, or prevent the licensor from
        granting licenses to anyone else.  These terms do not imply
        any other licenses.
        
        ## Patent Defense
        
        If you make any written claim that the software infringes or
        contributes to infringement of any patent, your patent license
        for the software granted under these terms ends immediately. If
        your company makes such a claim, your patent license ends
        immediately for work on behalf of your company.
        
        ## Violations
        
        The first time you are notified in writing that you have
        violated any of these terms, or done anything with the software
        not covered by your licenses, your licenses can nonetheless
        continue if you come into full compliance with these terms,
        and take practical steps to correct past violations, within
        32 days of receiving notice.  Otherwise, all your licenses
        end immediately.
        
        ## No Liability
        
        ***As far as the law allows, the software comes as is, without
        any warranty or condition, and the licensor will not be liable
        to you for any damages arising out of these terms or the use
        or nature of the software, under any kind of legal claim.***
        
        ## Definitions
        
        The **licensor** is the individual or entity offering these
        terms, and the **software** is the software the licensor makes
        available under these terms.
        
        **You** refers to the individual or entity agreeing to these
        terms.
        
        **Your company** is any legal entity, sole proprietorship,
        or other kind of organization that you work for, plus all
        organizations that have control over, are under the control of,
        or are under common control with that organization.  **Control**
        means ownership of substantially all the assets of an entity,
        or the power to direct its management and policies by vote,
        contract, or otherwise.  Control can be direct or indirect.
        
        **Your licenses** are all the licenses granted to you for the
        software under these terms.
        
        **Use** means anything you do with the software requiring one
        of your licenses.
        
Requires-Python: >=3.14
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: markdown
Requires-Dist: bs4
Dynamic: license-file


# Templix

[![PyPi](https://github.com/Omena0/templix/actions/workflows/publish.yml/badge.svg?branch=main)](https://github.com/Omena0/templix/actions/workflows/publish.yml)

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:

```json
{"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

```html
<title>{{ title }}</title>
```

Multiline

```html
<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:**

```html
{% if title %}
    <title>{{ title }}</title>
{% end %}
```

#### For statements

The block will be repeated for every element in the evaluated result.

**Example:**

```html
{% for page in pages %}
    <h2>{{ page.rsplit('.',1)[0].capitalize() }}</h2>
    <p>{{ open(page).read() }}</p>
    <br>
{% end %}
```

Pages definition (example)

```py
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.

```py
{% 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

```md
@using base.html
 $title Hello, World

# Hello, World!

This is an example!

@include content.html
```

##### base.html

```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

```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:**

```html
<!-- Stylesheet -->
<link rel="stylesheet" href="{{ url('style.css') }}">
<!-- Script -->
<script src="{{ url('script.js') }}"></script>
```
