AbsaOSS / AbsaOSS/living-doc-generator-mdoc

Add Jinja2 Templating Support

Aperta
#113 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
enhancement
Lingua principale
Python
Stelle
3
Fork
0
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

## Background
Our current templating setup (static frontmatter) lacks flexibility. It’s difficult to reuse layout components like headers, titles, and content blocks, and we can't easily inject logic (e.g., conditionals, loops). This results in duplicated code and makes content harder to maintain as the project grows.

## Feature
Introduce [Jinja2](https://pypi.org/project/Jinja2/) as a templating engine to support modular, dynamic templates using blocks ({% block content %}), includes, and variable injection. This would allow us to manage layout and content in a more scalable, DRY way.

## Example [Optional]
Instead of duplicating full-page layouts, we can do:

```
{% extends "base.jinja" %}

{% block content %}

User Stories


The comprehensive list of AqueDuct Project’s User Stories.


{% endblock %}
```

## Proposed Solution
Solution Ideas:
1. Set up a `templates/` folder and add Jinja2 as a dependency.
2. Add a minimal `render.py` script to compile `.jinja` templates into HTML or markdown.
3. Refactor an existing templates to use a Jinja2 layout.

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.