Hazel/STSG
1
2
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Compare commits

base: Hazel:c9fb8fda939e79f988645d0b2425f1d32cb66552
Branches Tags
Hazel:main Hazel:building_git_wiki Hazel:feature/isolating_value_building
...
compare: Hazel:feature/isolating_value_building
Branches Tags
Hazel:building_git_wiki Hazel:main Hazel:feature/isolating_value_building

13 Commits
c9fb8fda93 ... feature/is

Author SHA1 Message Date
Lars Noack
9b030b24f4 feat: added parent context 2025-04-16 16:42:21 +02:00
Lars Noack
44b651cace feat: move meta values to article 2025-04-16 16:39:06 +02:00
Lars Noack
eb2edc3710 feat: removed card templates 2025-04-16 16:17:57 +02:00
Lars Noack
f63497090b Revert "feat: removed redundand templates" 
This reverts commit 215142dee4.
 2025-04-16 16:17:13 +02:00
Lars Noack
215142dee4 feat: removed redundand templates 2025-04-16 16:09:18 +02:00
Lars Noack
e391f64cc5 feat: removed redundand methods 2025-04-16 16:08:25 +02:00
Lars Noack
4216d153fd feat: removed redundand methods 2025-04-16 16:08:11 +02:00
Lars Noack
9241ecfee8 feat: added dynamic children cards in templates 2025-04-16 16:07:20 +02:00
Lars Noack
4bc7a6d980 feat: added article translation templating 2025-04-16 16:01:38 +02:00
Lars Noack
b50833f19f feat: dynamic translation cards 2025-04-16 15:57:17 +02:00
Lars Noack
f5cccc30dc feat: dynamic translation cards 2025-04-16 15:56:34 +02:00
Lars Noack
8a8f02c5bd feat: implemented code to use with jinja 2025-04-16 15:45:06 +02:00
Lars Noack
292d71edc5 feat: added proper content 2025-04-16 15:26:43 +02:00
7 changed files with 196 additions and 201 deletions
Expand all files Collapse all files

3
.gitignore vendored
View File

@@ -173,4 +173,5 @@ cython_debug/
# PyPI configuration file # PyPI configuration file
.pypirc .pypirc
dist dist
context.json

80
src/templates/article.html
View File

@@ -1,9 +1,9 @@
<!DOCTYPE html> <!DOCTYPE html>
<html lang="{article_language_code}"> <html>
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>{article_language_flag} {article_title}</title> <title>{{slug}}</title>
<link rel="stylesheet" href="/static/bulma.min.css" /> <link rel="stylesheet" href="/static/bulma.min.css" />
</head> </head>
<body> <body>
@@ -14,24 +14,59 @@
aria-label="main navigation" aria-label="main navigation"
> >
<div class="navbar-brand"> <div class="navbar-brand">
<a class="navbar-item" href="{article_overview_url}"> <a class="navbar-item" href="#">
<strong>{article_language_flag} {article_title}</strong> <strong>Static Translated Site Generator</strong>
<time datetime="{article_datetime_iso}">{article_datetime}</time>
</a> </a>
</div> </div>
</nav> </nav>
<!-- Main Content -->
<section class="section"> <section class="section">
<div class="content"> {% if translations|length %}
{article_content} <div class="container content">
<div class="column is-half is-offset-one-quarter">
<h1>Further Reading</h1> <h1>Translations</h1>
</div>
<div class="row"> <div class="column is-half is-offset-one-quarter">
{article_children_cards} {% for t in translations %}
<div class="card mb-4" lang="{{t.language.code}}">
<a href="{{t.url}}" hreflang="{{t.language.code}}" class="card mb-4" style="color: inherit; text-decoration: none;">
<div class="card-content">
<p class="title">{{t.language.flag}} {{t.title}} </p>
<p class="content">
{{t.preview}}
<br />
<time datetime="{{iso_date}}">{{date}}</time>
</p>
</div>
</a>
</div>
{% endfor %}
</div> </div>
</div> </div>
{% endif %}
{% if children|length %}
<div class="container content">
<div class="column is-half is-offset-one-quarter">
<h1>Child Articles</h1>
</div>
<div class="column is-half is-offset-one-quarter">
{% for c in children %}
<div class="card mb-4" >
<a href="{{c.url}}" class="card mb-4" style="color: inherit; text-decoration: none;">
<div class="card-content">
<p class="title">{{c.slug}} </p>
<p class="content">
<time datetime="{{iso_date}}">{{date}}</time>
</p>
</div>
</a>
</div>
{% endfor %}
</div>
</div>
{% endif %}
</section> </section>
<!-- Footer --> <!-- Footer -->
@@ -41,4 +76,23 @@
</div> </div>
</footer> </footer>
</body> </body>
<script>
document.addEventListener("DOMContentLoaded", function () {
const userLang = navigator.language || navigator.userLanguage;
// Normalize and check if the language is not English or German
if (!["en", "de", "de-DE"].includes(userLang)) {
// Try to find a matching card by language attribute
const cardToMove =
document.querySelector(`.card[lang^="${userLang.replace("_", "-").toLowerCase()}"]`) ||
document.querySelector(`.card[lang^="${userLang.split("-")[0]}"]`);
if (cardToMove) {
const container = cardToMove.parentNode;
container.insertBefore(cardToMove, container.firstChild);
}
}
});
</script>
</html> </html>

12
src/templates/article_card.html
View File

@@ -1,12 +0,0 @@
<div class="card mb-4">
<a href="{article_url}" class="card mb-4" style="color: inherit; text-decoration: none;">
<div class="card-content">
<p class="title">{article_title} </p>
<p class="content">
{article_preview}
<br />
<time datetime="{article_datetime_iso}">{article_datetime}</time>
</p>
</div>
</a>
</div>

38
src/templates/article_translation.html Normal file
View File

@@ -0,0 +1,38 @@
<!DOCTYPE html>
<html lang="{article_language_code}">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>{{language.flag}} {{title}}</title>
<link rel="stylesheet" href="/static/bulma.min.css" />
</head>
<body>
<!-- Header (Navbar) -->
<nav
class="navbar is-primary"
role="navigation"
aria-label="main navigation"
>
<div class="navbar-brand">
<a class="navbar-item" href="{{article_url}}">
<strong>{{language.flag}} {{title}}</strong>
<time datetime="{{meta.iso_date}}">{{meta.date}}</time>
</a>
</div>
</nav>
<!-- Main Content -->
<section class="section">
<div class="content">
{{content}}
</div>
</section>
<!-- Footer -->
<footer class="footer">
<div class="content has-text-centered">
<p><strong>STSG</strong> by Hazel. &copy; 2025</p>
</div>
</footer>
</body>
</html>

69
src/templates/overview.html
View File

@@ -1,69 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>{article_title}</title>
<link rel="stylesheet" href="/static/bulma.min.css" />
</head>
<body>
<!-- Header (Navbar) -->
<nav
class="navbar is-primary"
role="navigation"
aria-label="main navigation"
>
<div class="navbar-brand">
<a class="navbar-item" href="#">
<strong>Static Translated Site Generator</strong>
</a>
</div>
</nav>
<section class="section">
<div class="container content">
<div class="column is-half is-offset-one-quarter">
<h1>Translations</h1>
</div>
<div class="column is-half is-offset-one-quarter">
{article_translation_cards}
</div>
</div>
<div class="container content">
<div class="column is-half is-offset-one-quarter">
<h1>Child Articles</h1>
</div>
<div class="column is-half is-offset-one-quarter">
{article_children_cards}
</div>
</div>
</section>
<!-- Footer -->
<footer class="footer">
<div class="content has-text-centered">
<p><strong>STSG</strong> by Hazel. &copy; 2025</p>
</div>
</footer>
</body>
<script>
document.addEventListener("DOMContentLoaded", function () {
const userLang = navigator.language || navigator.userLanguage;
// Normalize and check if the language is not English or German
if (!["en", "de", "de-DE"].includes(userLang)) {
// Try to find a matching card by language attribute
const cardToMove =
document.querySelector(`.card[lang^="${userLang.replace("_", "-").toLowerCase()}"]`) ||
document.querySelector(`.card[lang^="${userLang.split("-")[0]}"]`);
if (cardToMove) {
const container = cardToMove.parentNode;
container.insertBefore(cardToMove, container.firstChild);
}
}
});
</script>
</html>

12
src/templates/translation_card.html
View File

@@ -1,12 +0,0 @@
<div class="card mb-4" lang="{article_language_code}">
<a href="{article_url}" hreflang="{article_language_code}" class="card mb-4" style="color: inherit; text-decoration: none;">
<div class="card-content">
<p class="title">{article_language_flag} {article_title} </p>
<p class="content">
{article_preview}
<br />
<time datetime="{article_datetime_iso}">{article_datetime}</time>
</p>
</div>
</a>
</div>

183
stsg/build.py
View File

@@ -9,6 +9,7 @@ from bs4 import BeautifulSoup
from collections import defaultdict from collections import defaultdict
import toml import toml
from datetime import datetime from datetime import datetime
import jinja2
from . import config from . import config
@@ -30,6 +31,44 @@ def get_first_header_content(content, fallback: str = ""):
return fallback return fallback
def shorten_text_and_clean(html_string, max_length=config.formatting.article_preview_length):
soup = BeautifulSoup(html_string, 'html.parser')
# Keep track of total characters added
total_chars = 0
finished = False
# Function to recursively trim and clean text
def process_element(element):
nonlocal total_chars, finished
for child in list(element.children):
if finished:
child.extract()
continue
if isinstance(child, str):
remaining = max_length - total_chars
if remaining <= 0:
child.extract()
finished = True
elif len(child) > remaining:
child.replace_with(child[:remaining] + '...')
total_chars = max_length
finished = True
else:
total_chars += len(child)
elif hasattr(child, 'children'):
process_element(child)
# Remove empty tags
if not child.text.strip():
child.decompose()
process_element(soup)
return str(soup)
def stem_to_language_code(stem: str) -> str: def stem_to_language_code(stem: str) -> str:
language_code = stem.lower().replace("-", "_") language_code = stem.lower().replace("-", "_")
@@ -44,6 +83,24 @@ def stem_to_language_code(stem: str) -> str:
exit(1) exit(1)
class TemplateDict(dict):
def __init__(self, folder: Path):
self.folder = folder
super().__init__()
def __missing__(self, name: str) -> jinja2.Template:
f = self.folder / (name + ".html")
if not f.exists():
logger.error("no template with the name %s exists", name)
exit(1)
t = jinja2.Template(f.read_text())
self[name] = t
return t
TEMPLATE: Dict[str, jinja2.Template] = TemplateDict(Path(config.setup.source_directory, "templates"))
class LanguageDict(dict): class LanguageDict(dict):
def __missing__(self, key: str): def __missing__(self, key: str):
if key not in config.languages: if key not in config.languages:
@@ -61,15 +118,6 @@ class LanguageDict(dict):
LANGUAGES = LanguageDict() LANGUAGES = LanguageDict()
class Template:
def __init__(self, folder: Path):
self.folder = folder
self.article: str = (self.folder / "article.html").read_text()
self.overview: str = (self.folder / "overview.html").read_text()
self.translation_card: str = (self.folder / "translation_card.html").read_text()
self.article_card: str = (self.folder / "article_card.html").read_text()
class ArticleTranslation: class ArticleTranslation:
def __init__(self, file: Path, article: Article): def __init__(self, file: Path, article: Article):
@@ -97,52 +145,34 @@ class ArticleTranslation:
self.title = get_first_header_content(self.article_content, fallback="") self.title = get_first_header_content(self.article_content, fallback="")
def __init_context__(self): def __init_context__(self):
self.context["meta"] = self.article.context_meta self.context["meta"] = self.article.context_shared
self.context["url"] = self.url
self.context["language"] = LANGUAGES[self.language_code] self.context["language"] = LANGUAGES[self.language_code]
self.context["article_url"] = self.article.url
html_content = self.file.read_text()
if self.file.suffix == ".md":
html_content = markdown.markdown(html_content)
self.context["title"] = get_first_header_content(html_content, fallback=LANGUAGES[self.language_code]["native_name"])
self.context["content"] = html_content
self.context["preview"] = shorten_text_and_clean(html_string=html_content)
def build(self): def build(self):
self.dist_path.mkdir(parents=True, exist_ok=True) self.dist_path.mkdir(parents=True, exist_ok=True)
with Path(self.dist_path, "index.html").open("w") as f: with Path(self.dist_path, "index.html").open("w") as f:
f.write(self.get_article()) f.write(TEMPLATE["article_translation"].render(self.context))
def _get_values(self, return_foreign_articles: bool = True) -> Dict[str, str]:
r = {
"article_content": self.article_content,
"article_preview": self.article_preview,
"article_url": self.url,
"article_slug": self.article.slug,
"article_title": self.title,
}
if return_foreign_articles:
r.update(ARTICLE_REFERENCE_VALUES[self.language_code])
return r
def get_article_values(self) -> Dict[str, str]:
res = {}
for key, value in self._get_values(return_foreign_articles=False).items():
res[key + ":" + self.article.slug] = value
return res
def get_article(self) -> str:
return replace_values(TEMPLATE.article, self._get_values())
def get_translation_card(self) -> str:
return replace_values(TEMPLATE.translation_card, self._get_values())
def get_article_card(self) -> str:
return replace_values(TEMPLATE.article_card, self._get_values())
class Article: class Article:
def __init__(self, directory: Path, location_in_tree: Optional[List[str]] = None, is_root: bool = False): def __init__(self, directory: Path, location_in_tree: Optional[List[str]] = None, is_root: bool = False, parent: Optional[Article] = None):
self.directory = directory self.directory = directory
self.context: Dict[str, Any] = {} self.context: Dict[str, Any] = {}
self.context_meta = self.context["meta"] = {} self.context_shared: Dict[str, Any] = {}
if parent is not None:
self.context["parent"] = parent.context_shared
# initializing the config values of the article # initializing the config values of the article
config_file = self.directory / "index.toml" config_file = self.directory / "index.toml"
@@ -178,23 +208,22 @@ class Article:
self.child_articles.append(Article( self.child_articles.append(Article(
directory=c, directory=c,
location_in_tree=self.location_in_tree.copy(), location_in_tree=self.location_in_tree.copy(),
parent=self,
)) ))
self.article_translations_list.sort(key=lambda a: a.priority, reverse=True) self.article_translations_list.sort(key=lambda a: a.priority, reverse=True)
logger.info("found %s at %s with the translations %s", self.slug, ".".join(list(self.location_in_tree)), ",".join(self.article_translations_map.keys())) logger.info("found %s at %s with the translations %s", self.slug, ".".join(list(self.location_in_tree)), ",".join(self.article_translations_map.keys()))
# the tree is built
self.translation_cards = "\n".join(a.get_translation_card() for a in self.article_translations_list)
self.article_cards = "\n".join(c.get_article_card() for c in self.child_articles)
def __init_context__(self): def __init_context__(self):
self.context["url"] = self.url self.context_shared["url"] = self.url
self.context_meta["slug"] = self.slug self.context_shared["slug"] = self.slug
modified_at = datetime.fromisoformat(self.config["datetime"]) if "datetime" in self.config else datetime.fromtimestamp(self.directory.stat().st_mtime) modified_at = datetime.fromisoformat(self.config["datetime"]) if "datetime" in self.config else datetime.fromtimestamp(self.directory.stat().st_mtime)
self.context_meta["date"] = modified_at.strftime(config.formatting.datetime_format) self.context_shared["date"] = modified_at.strftime(config.formatting.datetime_format)
self.context_meta["iso_date"] = modified_at.isoformat() self.context_shared["iso_date"] = modified_at.isoformat()
self.context.update(self.context_shared)
# recursive context structures # recursive context structures
translation_list = self.context["translations"] = [] translation_list = self.context["translations"] = []
@@ -213,51 +242,21 @@ class Article:
for a in self.child_articles: for a in self.child_articles:
a.__init_context__() a.__init_context__()
def build(self): def build(self):
# builds the tree structure to the dist directory
self.dist_path.mkdir(parents=True, exist_ok=True) self.dist_path.mkdir(parents=True, exist_ok=True)
with Path(self.dist_path, "index.html").open("w") as f: with Path(self.dist_path, "index.html").open("w") as f:
f.write(self.get_overview()) f.write(TEMPLATE["article"].render(self.context))
for at in self.article_translations_list: for at in self.article_translations_list:
at.build() at.build()
for ca in self.child_articles: for ac in self.child_articles:
ca.build() ac.build()
def _get_values(self, return_foreign_articles: bool = True) -> Dict[str, str]:
r = {
"article_overview_url": self.url,
"article_translation_cards": self.translation_cards,
"article_children_cards": self.article_cards,
}
if return_foreign_articles:
r.update(ARTICLE_REFERENCE_VALUES[""])
return r
def get_article_values(self) -> Dict[str, str]:
res = {}
for key, value in self._get_values(return_foreign_articles=False).items():
res[key + ":" + self.slug] = value
return res
def get_overview(self) -> str:
global TEMPLATE
return replace_values(TEMPLATE.overview, self._get_values())
def get_article_card(self) -> str:
return replace_values(TEMPLATE.article_card, self._get_values())
# GLOBALS # GLOBALS
logger = logging.getLogger("stsg.build") logger = logging.getLogger("stsg.build")
TEMPLATE = Template(Path(config.setup.source_directory, "templates"))
ARTICLE_LAKE: Dict[str, Article] = {} ARTICLE_LAKE: Dict[str, Article] = {}
ARTICLE_REFERENCE_VALUES: DefaultDict[str, Dict[str, str]] = defaultdict(dict) ARTICLE_REFERENCE_VALUES: DefaultDict[str, Dict[str, str]] = defaultdict(dict)
@@ -269,17 +268,13 @@ def build():
logger.info("building page tree...") logger.info("building page tree...")
tree = Article(directory=Path(config.setup.source_directory, "articles"), is_root=True) tree = Article(directory=Path(config.setup.source_directory, "articles"), is_root=True)
logger.info("compiling tree context...") logger.info("compiling tree context...")
tree.__init_context__() tree.__init_context__()
import json import json
print(json.dumps(tree.context, indent=4)) with Path("context.json").open("w") as f:
json.dump(tree.context, f, indent=4)
# build article reverence values logger.info("dumping page tree...")
for article_overview in ARTICLE_LAKE.values(): tree.build()
ARTICLE_REFERENCE_VALUES[""].update(article_overview.get_article_values())
for language_code, at in article_overview.article_translations_map.items():
ARTICLE_REFERENCE_VALUES[language_code].update(at.get_article_values())
logger.info("writing page tree...")
# tree.build()