feat: setup documentation wegsite

src/articles/en.md

@@ -1,77 +1,9 @@
-# Populumque avidosque Sparte quoque auctore equidem
+# STSG
 
-## Sunt aevis
+![](/static/assets/logo.png)
 
-{{example.link}}
+This is a static-site-generator with focus on ease of use and making accessible websites. Thus the articles can be created in all relevant languages.
 
-Lorem markdownum turbavere prisca Aeacidae morando esse. Quam Styga spectata,
+The templates are completely customizable, but I still reccomend using [bulma](https://bulma.io/) as css-framework.
-pariter Iove iunctis exercere Solis? Atlantis possit succurrere quam!
 
-    if (stationRecord < ctp(rup, columnBase, dtd)) {
+Cops and Millitary of any state are stricly prohibited from using this tool.
-        impact_qbe_symbolic(bank_c(exploit_gnutella_social), inbox);
-        marketing = telnetWebmasterFpu;
-        circuitSoapDns(dac, ieee);
-    } else {
-        ebook.spider(wildcard_publishing_memory.tcpDisk(encoding, 48149), -1 +
-                copyright_flash_icmp, superscalar_cluster + kofficeIsp);
-        reimage.mac = dslWebmail;
-        kilobyteVariable.margin_keylogger = dvd + microcomputer;
-    }
-    font_switch(servlet, file(1, protocol) * skinTouchscreen,
-            wheel_station_computer);
-    var startRom = bit(php_touchscreen_icio);
-    var unicode_hover_tiger = command(scan_install_cd(ruby(mail_chipset, web,
-            clientMemeSoftware), optical, wirelessMegahertz), oasis);
-
-## Est nec locumque anxia et
-
-Maligno puppes potuit petit. **Ipse regnat venit** tangit mitti opibus est unus
-spectacula erat! Bacche qui dedit in ardet Phrygiis Liternum ipso ille Orphei
-Canentem *ut*, parenti terrae! Frondibus deus sine leoni frustraque lentus. Est
-deos cum corripuit erat sibi concussit simul; suus tantum.
-
-Camenis Lucifer ex geniti sitis quem. Styga si Ceae nova media remugis: haerens
-ridet, nam [Pindo](http://www.murra.com/argolicaemaximus) est tritis flamma
-[dixit una licebit](http://www.sedare-mopsus.net/) Pelia perdite! Aura *aurea
-mecum* una mirabantur mansit domum simul de Euboica altis vincula tenentis vires
-sub, *Scythicae*. Mora sitis pocula. Ultimus idem triplices inquit.
-
-## Et atque ministris imagine fas tenuit fornacibus
-
-Adeunda suffundit ille: Bacchi moribundo et quam **cacumina videre Tamasenum**.
-Gauderet in [non arbitrium caelo](http://www.madidusperiuraque.io/).
-
-## In corpora in micat Phoebus corque transitus
-
-Mihi in macies, ab avoque malorum decusque. Appellant expellam unus colore
-exiguo, maior ara loqui sit vires.
-
-    var uat = cardPrinterLocalhost.pppoe(display, operating_row_fsb(
-            scalable_lion, compilerHeuristicTweet - 22));
-    var toslink_software = tokenPciPrompt.source_x_firmware(drive,
-            boxSdkDlc.servicesIcsDrive(certificate_cycle_illegal(resolution)),
-            outboxTftMap + rssTextZebibyte.flashImpactDisk(3, eup_ad));
-    var compression = programWebPort;
-    if (intellectual_left_system) {
-        favorites(lossyDramDay + 7, upsSliTruncate, 2);
-        laptop.android = ocr_piracy(clean, flatbedRte - -1);
-        directx_file_cable = -1;
-    } else {
-        point_sink_controller(flash(filenameDataAccess, vleSoftwareListserv),
-                point_rate_cmos(control_soa_restore));
-        javascript *= nic_format;
-        address = nameDcim(touchscreenLink.port_port(diskHeat, vaporware));
-    }
-
-## Enim nunc solvi
-
-Est pudet citharae, corpus? Modo in armentaque pennisque videri aquarum, est
-equos ne in vulnere domus; maris. Quodque quoque orbe omnes metus, sol
-[putas](http://www.uno.com/deorumvolumine) marmore fuit secreta haut vobis,
-faciendo, oro.
-
-Quid sequenti, supersunt quoque, sortite; in in tenetur vecta horriferamque
-amabat. Vos nudae anni amor chelydri [Picus candentibus
-et](http://pugnare.io/angulus.html) sonum, et sentibus geminato volucrem
-mercibus bracchia, cum *posito* delubraque. Templa extrahit in totidem altera
-Nioben, honoris sui, fibris!

src/articles/example/de-DE.md

@@ -1,59 +0,0 @@
-meow
-
-# Abstrahere reddita celebrare in ossa
-
-## Usque de celebrabant puer
-
-[{{index_page.title}}]({{index_page.url}})
-
-Lorem markdownum, nec ora et vero me nec natae suadent. Nec damno ignorat
-propiore aliquid temptata decipienda habetur. Vulnera lacrimis aequoreo madidos,
-copia uvae, herbosaque quoque, per harenas, canos fui monstro Peleus.
-
-Et fuge cum liquidum puer Herculis arentis, tantum caudaque et generi vilior, in
-rubore. Caeli modo palmis, suo tria accipe visus non similis qui remittat
-retentus porrigit fluxit ubi testis.
-
-> Sulphura et color reliquit dextera: quid summa continuere obductos egesto
-> moriens **fluentia vult iunctamque**, mihi patres spiro. Est Iovis **imperat
-> quem est** putavi annis *omnis*; flumina, leporem constabat grave pelagi,
-> insiluit, igne invito? Auctor circuit quod.
-
-## Rhoetus gravis
-
-Parari modo in sustulerat: ora sic verba meruit, uti. Pignora citus facto
-amplectimur cupido amentes foedantem multoque datura.
-[Quid](http://www.prima.net/se) ex tanti armaque exhibita descenderat!
-
-1. Alis ima
-2. Mirantur nive sit
-3. Maris ut adlabimur humana fine quam vultusque
-
-## A idonea miserum
-
-Montes tibi deorum igitur. Poterat nunc porrigitur perdidimus *sidereos animi
-praesepia* nihil praeferri functa, in **Pleias removete** oculos sollemni
-Tatius: **modo**. Inde dedit! Atque in matrem spinae foret ponti quam dixit,
-aras. Gladii addendum fiducia magno, se quo fata humo esse **tellure corpora
-discederet** sucis manibus, parentem ante, Iovem.
-
-Laqueique honore sequentia tyranni Harpalos, paelex, foedat tempestiva nomen.
-Sit ter indiciumque requirit utrumque in nil et *suspectus*, quaerite patriam
-nec facta [securi](http://heuqua.io/adhaut). Confessa ut per sit nostro futura
-metaque oblitae fameque exit adspiciens. Morte flectere invidiam certe cum
-vixque *nubes clamor viderunt* praeceps infamis collo percussis axem plena saxum
-urbes ferre undae. Totoque utuntur ore lupus inplet sibila ullam, qui corpore
-*contermina aera*?
-
-Convocat ipse abeunt sententia concolor a Auguste epops solent iubet qui
-aequora. In illi, solvente resecare violentam nescio accipit multarum [aureus
-exspectatus](http://oris-tibi.io/nasci) ergo ora. Positis **inquit**, sit iamque
-hederae ulterius, pontus linguae matutina terra sic isse Graium passosque
-sanguinis secus petit!
-
-Adfore dei volucrum Lydas; [hoc](http://similemnescitve.net/ipsamquee) quam
-[superosque](http://www.quoqueabit.com/cumqueiam.html) caligine vulnera quoque
-corpus foedaque mentis qui nectare, fatendo sensit! Rursus nulli miraris nuda
-*Acrisio*. Cum modo, satis dissuadet luce; cum *freta* ab et diu, labor *tenuata
-ieiunia*? Caesosque thalamique precor, dedit nulla loca [arce
-et](http://viscera-rerum.com/mixta) tinguit aera.

src/articles/example/en.md

@@ -1,75 +0,0 @@
-# Populumque avidosque Sparte quoque auctore equidem
-
-## Sunt aevis
-
-Lorem markdownum turbavere prisca Aeacidae morando esse. Quam Styga spectata,
-pariter Iove iunctis exercere Solis? Atlantis possit succurrere quam!
-
-    if (stationRecord < ctp(rup, columnBase, dtd)) {
-        impact_qbe_symbolic(bank_c(exploit_gnutella_social), inbox);
-        marketing = telnetWebmasterFpu;
-        circuitSoapDns(dac, ieee);
-    } else {
-        ebook.spider(wildcard_publishing_memory.tcpDisk(encoding, 48149), -1 +
-                copyright_flash_icmp, superscalar_cluster + kofficeIsp);
-        reimage.mac = dslWebmail;
-        kilobyteVariable.margin_keylogger = dvd + microcomputer;
-    }
-    font_switch(servlet, file(1, protocol) * skinTouchscreen,
-            wheel_station_computer);
-    var startRom = bit(php_touchscreen_icio);
-    var unicode_hover_tiger = command(scan_install_cd(ruby(mail_chipset, web,
-            clientMemeSoftware), optical, wirelessMegahertz), oasis);
-
-## Est nec locumque anxia et
-
-Maligno puppes potuit petit. **Ipse regnat venit** tangit mitti opibus est unus
-spectacula erat! Bacche qui dedit in ardet Phrygiis Liternum ipso ille Orphei
-Canentem *ut*, parenti terrae! Frondibus deus sine leoni frustraque lentus. Est
-deos cum corripuit erat sibi concussit simul; suus tantum.
-
-Camenis Lucifer ex geniti sitis quem. Styga si Ceae nova media remugis: haerens
-ridet, nam [Pindo](http://www.murra.com/argolicaemaximus) est tritis flamma
-[dixit una licebit](http://www.sedare-mopsus.net/) Pelia perdite! Aura *aurea
-mecum* una mirabantur mansit domum simul de Euboica altis vincula tenentis vires
-sub, *Scythicae*. Mora sitis pocula. Ultimus idem triplices inquit.
-
-## Et atque ministris imagine fas tenuit fornacibus
-
-Adeunda suffundit ille: Bacchi moribundo et quam **cacumina videre Tamasenum**.
-Gauderet in [non arbitrium caelo](http://www.madidusperiuraque.io/).
-
-## In corpora in micat Phoebus corque transitus
-
-Mihi in macies, ab avoque malorum decusque. Appellant expellam unus colore
-exiguo, maior ara loqui sit vires.
-
-    var uat = cardPrinterLocalhost.pppoe(display, operating_row_fsb(
-            scalable_lion, compilerHeuristicTweet - 22));
-    var toslink_software = tokenPciPrompt.source_x_firmware(drive,
-            boxSdkDlc.servicesIcsDrive(certificate_cycle_illegal(resolution)),
-            outboxTftMap + rssTextZebibyte.flashImpactDisk(3, eup_ad));
-    var compression = programWebPort;
-    if (intellectual_left_system) {
-        favorites(lossyDramDay + 7, upsSliTruncate, 2);
-        laptop.android = ocr_piracy(clean, flatbedRte - -1);
-        directx_file_cable = -1;
-    } else {
-        point_sink_controller(flash(filenameDataAccess, vleSoftwareListserv),
-                point_rate_cmos(control_soa_restore));
-        javascript *= nic_format;
-        address = nameDcim(touchscreenLink.port_port(diskHeat, vaporware));
-    }
-
-## Enim nunc solvi
-
-Est pudet citharae, corpus? Modo in armentaque pennisque videri aquarum, est
-equos ne in vulnere domus; maris. Quodque quoque orbe omnes metus, sol
-[putas](http://www.uno.com/deorumvolumine) marmore fuit secreta haut vobis,
-faciendo, oro.
-
-Quid sequenti, supersunt quoque, sortite; in in tenetur vecta horriferamque
-amabat. Vos nudae anni amor chelydri [Picus candentibus
-et](http://pugnare.io/angulus.html) sonum, et sentibus geminato volucrem
-mercibus bracchia, cum *posito* delubraque. Templa extrahit in totidem altera
-Nioben, honoris sui, fibris!

src/articles/example/ku.md

@@ -1,35 +0,0 @@
-# Navê Gotarê example
-Ev gotar, mînakek placeholder ya bi zimanê Kurdî ye. Nivîs, weşan û rûpelên nûçe di vê belgeyê de têne pêşniyar kirin. Ev metn ji bo testkirina layout an jî demo-yê hatiye çêkirin û çend bingehên cihanî yên naveroka gotarê nîşan dide.
-
-## Destpêk
-Di destpêka gotarê de, dikarin rêvekên bingehîn û armancên mijarê vebêjin. Tu dikarî vê metnê bikar bînin ji bo şexsî an jî projeyên xwe:
-  
-Lorem ipsum ji bo kurdî:  
-"Rojên nû û şevên hêja, ev nivîs têne çêkirin ku bi awayek nîşanbideke cîhan û hunermendî were afirandin."
-
-## Lêkolîn û Naverok
-Di vê beşê de hinek îzahiyên naverokî yên placeholder hatine peyda kirin. Hûn dikarin bi rêza li jêr anînên mifteyî yên gotarê şop bikin:
-
-- **Mijar:** Di vê gotarê de, mijarên bi zor û hêja têne nîşandan.
-- **Rêbaz:** Ew kesên ku ji ber vê gotarê şîrove û daxuyanî dikin, çavkaniyên xwe diguhezînin.
-- **Agahî:** Di vê derbarê de, agahîyên cihanî, dîtin û têgihiştin hatine berhev kirin.
-
-Di bin vê şexsiyeta, hertişt di dema xwe de têgihiştin û anîn pêşiyê dayîn.
-
-## Şirove û Kod
-Di vê paragrafa kêm-kêm de, em dikarin bingehên şiroveyê yên gotarê di kodê de jî şop bikin:
-
-```python
-def peyama_kurdî():
-    mesaj = "Her bijî Kurdistan! Rojên baş û serkeftin!"
-    return mesaj
-
-print(peyama_kurdî())
-```
-
-Kodê li ser vê koda simplesa gotinê ye û dikare weşana nûçe an demo-yê projeyan bixebite.
-
-# Encama Gotarê
-
-Di encama gotarê de, hûn dikarin her çend beşên bingehîn yên nûçe, daxuyanî û şirove yên navekî bifikirin.
-Bê guman, ev placeholder bi awayek qelew li ser çalakiya te ya malper, blog an jî her sedema dijîtal tê de karîger e.

src/articles/index.toml

@@ -1,2 +1,2 @@
-name="index_page"
+name="stsg"
 datetime="2024-04-15 13:45:12.123456"

src/articles/ku.md

@@ -1,38 +0,0 @@
-# Navê Gotarê
-
-[{{example.title}}]({{example.url}})
-
-Ev gotar, mînakek placeholder ya bi zimanê Kurdî ye. Nivîs, weşan û rûpelên nûçe di vê belgeyê de têne pêşniyar kirin. Ev metn ji bo testkirina layout an jî demo-yê hatiye çêkirin û çend bingehên cihanî yên naveroka gotarê nîşan dide.
-
-## Destpêk
-Di destpêka gotarê de, dikarin rêvekên bingehîn û armancên mijarê vebêjin. Tu dikarî vê metnê bikar bînin ji bo şexsî an jî projeyên xwe:
-  
-Lorem ipsum ji bo kurdî:  
-"Rojên nû û şevên hêja, ev nivîs têne çêkirin ku bi awayek nîşanbideke cîhan û hunermendî were afirandin."
-
-## Lêkolîn û Naverok
-Di vê beşê de hinek îzahiyên naverokî yên placeholder hatine peyda kirin. Hûn dikarin bi rêza li jêr anînên mifteyî yên gotarê şop bikin:
-
-- **Mijar:** Di vê gotarê de, mijarên bi zor û hêja têne nîşandan.
-- **Rêbaz:** Ew kesên ku ji ber vê gotarê şîrove û daxuyanî dikin, çavkaniyên xwe diguhezînin.
-- **Agahî:** Di vê derbarê de, agahîyên cihanî, dîtin û têgihiştin hatine berhev kirin.
-
-Di bin vê şexsiyeta, hertişt di dema xwe de têgihiştin û anîn pêşiyê dayîn.
-
-## Şirove û Kod
-Di vê paragrafa kêm-kêm de, em dikarin bingehên şiroveyê yên gotarê di kodê de jî şop bikin:
-
-```python
-def peyama_kurdî():
-    mesaj = "Her bijî Kurdistan! Rojên baş û serkeftin!"
-    return mesaj
-
-print(peyama_kurdî())
-```
-
-Kodê li ser vê koda simplesa gotinê ye û dikare weşana nûçe an demo-yê projeyan bixebite.
-
-# Encama Gotarê
-
-Di encama gotarê de, hûn dikarin her çend beşên bingehîn yên nûçe, daxuyanî û şirove yên navekî bifikirin.
-Bê guman, ev placeholder bi awayek qelew li ser çalakiya te ya malper, blog an jî her sedema dijîtal tê de karîger e.

src/templates/article.html

@@ -6,6 +6,7 @@
     <link rel="icon" type="image/x-icon" href="/static/icon.ico">
     <title>{{slug}}</title>
     <link rel="stylesheet" href="/static/bulma.min.css" />
+    <link rel="stylesheet" href="/static/style.css" />
   </head>
   <body>
     <nav
@@ -31,12 +32,8 @@
             <div class="column is-half">
               <div class="card mb-4" lang="{{t.language.code}}" style="height: 100%;">
                 <a href="{{t.url}}" hreflang="{{t.language.code}}" class="card mb-4" style="color: inherit; text-decoration: none;">
-                  <div class="card-header">
-                    <div class="card-header-title">{{t.title}} </div>
-                    <div class="card-header-icon">{{t.language.flag}}</div>
-                  </div>  
-                  
                   <div class="card-content">
+                        <p class="title">{{t.language.flag}} {{t.title}}</p>
                         <hr />
                         <p class="content">
                             {{t.preview}}
@@ -44,7 +41,7 @@
                     </div>
 
                     <div class="card-footer">
-                      <time datetime="{{iso_date}}">{{date}}</time>
+                      <time class="card-footer-item" datetime="{{iso_date}}">{{date}}</time>
                     </div>
                 </a>
             </div>
@@ -58,7 +55,7 @@
       {% if children|length %}
       <div class="container content">
         <div class="column is-half is-offset-one-quarter">
-          <h1>Further reading</h1>
+          <h1>Related Articles</h1>
         </div>
         <div class="column is-half is-offset-one-quarter">
             {% for c in children %}

src/templates/article_translation.html

@@ -4,8 +4,9 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <link rel="icon" type="image/x-icon" href="/static/icon.ico">
-    <title>{{language.flag}} {{title}}</title>
+    <title>{{title}}</title>
     <link rel="stylesheet" href="/static/bulma.min.css" />
+    <link rel="stylesheet" href="/static/style.css" />
   </head>
   <body>
     <!-- Header (Navbar) -->
@@ -29,6 +30,34 @@
       </div>
     </section>
 
+    {% if children|length %}
+    <section class="section">
+      <div class="content">
+        <div class="columns is-multiline">
+            {% for c in children %}
+            <div class="column is-half">
+              <div class="card mb-4" >
+                <a href="{{c.url}}" hreflang="{{c.language.code}}" class="card mb-4" style="color: inherit; text-decoration: none;">
+                  <div class="card-content">
+                        <p class="title">{{c.title}}</p>
+                        <hr />
+                        <p class="content">
+                            {{c.preview}}
+                        </p>
+                    </div>
+
+                    <div class="card-footer">
+                      <time class="card-footer-item" datetime="{{c.meta.iso_date}}">{{c.meta.date}}</time>
+                    </div>
+                </a>
+            </div>
+          </div>
+          {% endfor %}
+        </div>
+      </div>
+    </section>
+    {% endif %}
+
     <!-- Footer -->
     <footer class="footer">
       <div class="content has-text-centered">

stsg/build.py

@@ -209,7 +209,7 @@ class Article:
         self.config = toml.load(config_file) if config_file.exists() else {}
 
         # initializing the location and slug of the article
-        self.slug = self.config.get("name", self.directory.name) 
+        self.slug = self.config.get("name", self.directory.name)
         if self.slug in ARTICLE_LAKE:
             logger.error("two articles have the same name at %s and %r", ARTICLE_LAKE[self.slug].directory, self.directory)
             exit(1)