AbsaOSS / AbsaOSS/living-doc-generator-mdoc

Add Jinja2 Templating Support

オープン
#113 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
enhancement
主要言語
Python
スター
3
フォーク
0
PR マージ指標
30日以内にマージされた PR はありません

説明

## 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.

コントリビューションガイド

コントリビューションガイドを開く

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。