Compare commits
5 Commits
8fee8d879e
...
building_g
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e1fd352b1f | ||
|
|
a4aa73b1aa | ||
|
|
73e89ca513 | ||
|
|
a1900a77e4 | ||
|
|
258d062ff4 |
25
README.md
25
README.md
@@ -1,4 +1,15 @@
|
||||
# Installing
|
||||
<a href="https://oql.avris.it/license/v1.2" target="_blank" rel="noopener"><img src="https://badgers.space/badge/License/OQL/pink" alt="License: OQL" style="vertical-align: middle;"/></a>
|
||||
|
||||
# STSG
|
||||
|
||||
## Planned features
|
||||
|
||||
- [ ] auto uploading to ftp and other online services using a plugin system
|
||||
- [ ] build a git wiki in a specified languages instead of a static website
|
||||
- [ ] hosting the documentation somehow
|
||||
- [ ] multiple templates + a way to choose templates
|
||||
|
||||
## Installing
|
||||
|
||||
```sh
|
||||
python3 -m venv .venv
|
||||
@@ -6,7 +17,7 @@ source .venv/bin/activate
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
# Execute
|
||||
## Execute
|
||||
|
||||
To start a local http server in the dist folder you can simply do:
|
||||
|
||||
@@ -24,13 +35,3 @@ stsg
|
||||
stsg_dev
|
||||
```
|
||||
|
||||
# build favicon
|
||||
|
||||
```
|
||||
cd src/static/assets
|
||||
inkscape -w 16 -h 16 -o 16.png logo.svg
|
||||
inkscape -w 32 -h 32 -o 32.png logo.svg
|
||||
inkscape -w 48 -h 48 -o 48.png logo.svg
|
||||
|
||||
convert 16.png 32.png 48.png ../icon.ico
|
||||
```
|
||||
|
||||
@@ -13,6 +13,9 @@ readme = "README.md"
|
||||
requires-python = ">=3.8"
|
||||
classifiers = []
|
||||
version = "0.0.0"
|
||||
license-files = [
|
||||
"LICENSE"
|
||||
]
|
||||
|
||||
[project.scripts]
|
||||
stsg = "stsg.__main__:build"
|
||||
|
||||
@@ -6,4 +6,4 @@ Dies ist ein Static Site Generator mit fokus auf Nutzer:innenfreundlichkeit und
|
||||
|
||||
Die Templates sind komplet anpassbar, trotzdem empfehle ich [Bulma](https://bulma.io/) als CSS-Framework zu verwenden.
|
||||
|
||||
Polizei und das Millitär jeglichen Staates dürfen dieses Tool nicht verwenden.
|
||||
Polizei und das Millitär jeglichen Staates dürfen dieses Tool nicht verwenden. Für mehr Info zur Nutzung lest [die Lizenz]({{license.url}}).
|
||||
|
||||
@@ -96,7 +96,7 @@
|
||||
<!-- Footer -->
|
||||
<footer class="footer">
|
||||
<div class="content has-text-centered">
|
||||
<p><strong>{{name}}</strong> by {{author}}. © 2025</p>
|
||||
<p><strong>{{name}}</strong> by {{author}}. © {{year}}</p>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
|
||||
@@ -72,7 +72,7 @@
|
||||
<!-- Footer -->
|
||||
<footer class="footer">
|
||||
<div class="content has-text-centered">
|
||||
<p><strong>{{name}}</strong> by {{author}}. © 2025</p>
|
||||
<p><strong>{{name}}</strong> by {{author}}. © {{year}}</p>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
|
||||
@@ -18,7 +18,12 @@ logger = logging.getLogger("stsg")
|
||||
|
||||
|
||||
def build():
|
||||
complete_build()
|
||||
build_wiki()
|
||||
# complete_build()
|
||||
|
||||
|
||||
def build_wiki():
|
||||
pass
|
||||
|
||||
|
||||
class MarkdownChangeHandler(FileSystemEventHandler):
|
||||
|
||||
@@ -238,6 +238,7 @@ class ArticleTranslation:
|
||||
self.context["url"] = self.url
|
||||
add_html_link(self.context)
|
||||
self.context["date"] = self.article.modified_at.strftime(config.formatting.datetime_format)
|
||||
self.context["year"] = str(self.article.modified_at.year)
|
||||
self.context["iso_date"] = self.article.modified_at.isoformat()
|
||||
self.context["author"] = self.article.author
|
||||
|
||||
@@ -276,6 +277,9 @@ class ArticleTranslation:
|
||||
with Path(self.dist_path, "index.html").open("w") as f:
|
||||
f.write(TEMPLATE["article_translation"].render(self.context))
|
||||
|
||||
def build_wiki(self, language_code: str):
|
||||
pass
|
||||
|
||||
|
||||
class Article:
|
||||
directory: Path
|
||||
@@ -383,6 +387,7 @@ class Article:
|
||||
self.context["url"] = self.url
|
||||
add_html_link(self.context)
|
||||
self.context["date"] = self.modified_at.strftime(config.formatting.datetime_format)
|
||||
self.context["year"] = str(self.modified_at.year)
|
||||
self.context["iso_date"] = self.modified_at.isoformat()
|
||||
self.context["author"] = self.author
|
||||
|
||||
|
||||
@@ -15,6 +15,7 @@ class ArticleContext(TypedDict):
|
||||
url: str
|
||||
link: str
|
||||
date: str
|
||||
year: str
|
||||
iso_date: str
|
||||
author: str
|
||||
|
||||
@@ -39,6 +40,7 @@ class ArticleTranslationContext(TypedDict):
|
||||
url: str
|
||||
link: str
|
||||
date: str
|
||||
year: str
|
||||
iso_date: str
|
||||
author: str
|
||||
|
||||
|
||||
Reference in New Issue
Block a user