diff --git a/.github/workflows/blog-preview.yml b/.github/workflows/blog-preview.yml new file mode 100644 index 0000000..5e7b76d --- /dev/null +++ b/.github/workflows/blog-preview.yml @@ -0,0 +1,68 @@ +name: Blog Preview Deployment + +on: + push: + branches: + - 'blog/**' # Triggers only on pushes to branches starting with 'blog/' + +jobs: + deploy-preview: + runs-on: ubuntu-22.04 + permissions: + contents: write + concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + steps: + - uses: actions/checkout@v4 + + - name: Setup Python + uses: actions/setup-python@v5 + with: + python-version: '3.13' + + - name: Upgrade pip + run: | + # install pip=>20.1 to use "pip cache dir" + python3 -m pip install --upgrade pip + + - name: Get pip cache dir + id: pip-cache + run: echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT + + - name: Cache dependencies + uses: actions/cache@v4 + with: + path: ${{ steps.pip-cache.outputs.dir }} + key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }} + restore-keys: | + ${{ runner.os }}-pip- + + - name: Install dependencies + run: python3 -m pip install -r ./requirements.txt + + - name: Configure site_url for fork preview + run: | + # Extract GitHub username and repo name + GITHUB_USER=$(echo $GITHUB_REPOSITORY | cut -d '/' -f 1) + REPO_NAME=$(echo $GITHUB_REPOSITORY | cut -d '/' -f 2) + + # Update site_url in mkdocs.yml for fork preview + if grep -q "^site_url:" mkdocs.yml; then + sed -i "s|^site_url:.*|site_url: https://$GITHUB_USER.github.io/${REPO_NAME}/|" mkdocs.yml + else + echo "site_url: https://$GITHUB_USER.github.io/${REPO_NAME}/" >> mkdocs.yml + fi + + echo "Updated mkdocs.yml for preview deployment:" + cat mkdocs.yml + + - name: Build css + run: | + npm install + npm run scss:build + + - name: Build static site + run: mkdocs build + + - name: Deploy to GitHub Pages + run: mkdocs gh-deploy --force diff --git a/.gitignore b/.gitignore index 8978369..dcf69b7 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,5 @@ .idea .cache -site/.htaccess -site/.htpasswd -site/ -docs/stylesheets/extra.css +/site +/docs/assets/css/custom.css +/package-lock.json diff --git a/compile_scss.py b/compile_scss.py index aee4c96..40d8e2a 100644 --- a/compile_scss.py +++ b/compile_scss.py @@ -6,7 +6,7 @@ from watchdog.observers import Observer from watchdog.events import FileSystemEventHandler # Pfade konfigurieren -scss_file = "docs/stylesheets/extra.scss" +scss_file = "overrides/assets/stylesheets/custom.scss" css_file = "docs/stylesheets/extra.css" def compile_scss(): diff --git a/docker/mkdocs-material/Dockerfile b/docker/mkdocs-material/Dockerfile index d72a32a..3130ecc 100644 --- a/docker/mkdocs-material/Dockerfile +++ b/docker/mkdocs-material/Dockerfile @@ -8,4 +8,5 @@ RUN pip install mkdocs-snippets RUN pip install mkdocs-exclude RUN pip install mkdocs-git-revision-date-localized-plugin RUN pip install mkdocs-redirects -RUN pip install mkdocs-literate-nav \ No newline at end of file +RUN pip install mkdocs-literate-nav +RUN pip install mkdocs-minify-plugin \ No newline at end of file diff --git a/docs/assets/javascript/body-classes.js b/docs/assets/js/body-classes.js similarity index 95% rename from docs/assets/javascript/body-classes.js rename to docs/assets/js/body-classes.js index 3b883fb..bffae7e 100644 --- a/docs/assets/javascript/body-classes.js +++ b/docs/assets/js/body-classes.js @@ -24,8 +24,8 @@ function updateBodyClasses() { document.body.classList.remove(className); }); - // Wenn der Pfad leer ist (Startseite), füge die Klasse 'home' hinzu - if (cleanPath === '') { + // Wenn der Pfad leer oder eine Entwickler Github Page ist (Startseite), füge die Klasse 'home' hinzu + if (cleanPath === '' || cleanPath === 'satware.ai') { document.body.classList.add('home'); } else { // Teile den Pfad in Segmente auf diff --git a/docs/assets/javascript/consent.js b/docs/assets/js/consent.js similarity index 100% rename from docs/assets/javascript/consent.js rename to docs/assets/js/consent.js diff --git a/docs/assets/javascript/counter-animation.js b/docs/assets/js/counter-animation.js similarity index 100% rename from docs/assets/javascript/counter-animation.js rename to docs/assets/js/counter-animation.js diff --git a/docs/assets/javascript/faq.js b/docs/assets/js/faq.js similarity index 100% rename from docs/assets/javascript/faq.js rename to docs/assets/js/faq.js diff --git a/docs/assets/javascript/lightbox.js b/docs/assets/js/lightbox.js similarity index 100% rename from docs/assets/javascript/lightbox.js rename to docs/assets/js/lightbox.js diff --git a/docs/assets/javascript/testimonials.js b/docs/assets/js/testimonials.js similarity index 100% rename from docs/assets/javascript/testimonials.js rename to docs/assets/js/testimonials.js diff --git a/docs/assets/javascript/wcag.js b/docs/assets/js/wcag.js similarity index 100% rename from docs/assets/javascript/wcag.js rename to docs/assets/js/wcag.js diff --git a/docs/blog/.authors.yml b/docs/blog/.authors.yml index e27287b..4897f6a 100644 --- a/docs/blog/.authors.yml +++ b/docs/blog/.authors.yml @@ -2,9 +2,14 @@ authors: tim-alesi: name: Tim Alesi description: KI-Agent - avatar: ../assets/images/team/team-alesi.jpg + avatar: assets/images/team/team-alesi.jpg jane-alesi: name: Jane Alesi description: Leitende KI-Architektin avatar: assets/images/team/jane-alesi.jpg - url: /team/jane.md + url: ../team/jane.html + michael-wegener: + name: Michael Wegener + description: Entwickler satware.ai + avatar: https://satware.com/media/image/0c/a5/32/mw.jpg + url: https://satware.com/MW diff --git a/docs/blog/posts/2025-05-20-relaunch-mit-mkdocs.md b/docs/blog/posts/2025-05-20-relaunch-mit-mkdocs.md new file mode 100644 index 0000000..56404ea --- /dev/null +++ b/docs/blog/posts/2025-05-20-relaunch-mit-mkdocs.md @@ -0,0 +1,94 @@ +--- +date: 2025-05-20 +title: "Relaunch der satware.ai-Website mit MkDocs" +description: "Ein ausführlicher Einblick in die technische Implementierung unseres Website-Relaunches mit MkDocs und die Integration von Mermaid-Diagrammen" +authors: [michael-wegener] +categories: + - Entwicklung + - Dokumentation +tags: + - MkDocs + - GitHub + - Mermaid + - Workflow +--- + +# Relaunch der satware.ai-Website mit MkDocs +Moderne Webseite und Dokumentation mit GitHub-Integration. +Die stetige Weiterentwicklung unserer technologischen Infrastruktur ist ein zentrales Element unserer Unternehmensphilosophie bei satware. In diesem Geist freuen wir uns, den Relaunch unserer Website satware.ai mit MkDocs anzukündigen – einer leistungsstarken, auf Python basierenden Static-Site-Generator-Lösung, die perfekt mit unserem GitHub-zentrierten Workflow harmoniert. + +## Warum MkDocs? Technologische Vorteile im Überblick + +MkDocs hat sich als die ideale Plattform für unsere Anforderungen erwiesen. Die Entscheidung für diese Technologie basiert auf mehreren technischen Vorteilen, die unseren Entwicklungsprozess optimieren: + +- Markdown-basierte Inhalte: Schnelles und effizientes Content-Management mit der vertrauten Markdown-Syntax +- Automatisierte Deployment-Pipeline: Nahtlose Integration mit GitHub Actions für kontinuierliche Aktualisierungen +- Responsive Design: Optimale Darstellung auf allen Endgeräten durch moderne CSS-Frameworks +- Erweiterbarkeit: Umfangreiche Plugin-Unterstützung für zusätzliche Funktionalitäten +- Integrierte Suchfunktion: Leistungsstarke clientseitige Suche ohne Server-Komponenten +- Mehrsprachige Unterstützung: Einfache Lokalisierung und Internationalisierung +- Automatische Generierung von Inhalten durch unsere [KI-Agenten](../../team/index.md) + +## Technische Implementation mit GitHub Pages + +Der Relaunch basiert auf einer technisch ausgereiften Pipeline, die moderne DevOps-Praktiken implementiert. Unser Workflow nutzt die Leistungsfähigkeit von GitHub Actions für die automatisierte Generierung und Deployment der Website: + +Die Grundlage bildet ein speziell konfigurierter GitHub-Workflow, der bei jeder Änderung im Repository automatisch ausgeführt wird. + + +## Integration von Mermaid-Diagrammen + +Ein besonderes Highlight unseres neuen Setups ist die native Integration von Mermaid-Diagrammen. Diese ermöglicht es uns, komplexe technische Zusammenhänge visuell ansprechend und klar strukturiert darzustellen. Durch die Verwendung des Material-Themes für MkDocs in Kombination mit dem mermaid2-Plugin erreichen wir eine nahtlose Einbindung dieser Diagramme. + +Die Mermaid-Integration bietet folgende Vorteile: + +- Codebasierte Diagramme: Versionierbar und leicht zu warten +- Automatische Anpassung an das gewählte Farbschema (Light/Dark Mode) +- Breite Unterstützung verschiedener Diagrammtypen: Flowcharts, Sequenzdiagramme, Klassendiagramme usw. +- Responsive Darstellung auf allen Endgeräten + +Hier ein Beispiel-Workflow, der unseren GitHub-basierten Deployment-Prozess visualisiert: + +### Beispiel: GitHub-basierter MkDocs-Deployment-Workflow + +```mermaid +flowchart LR + A[Lokales Repository] -->|git push| B[GitHub Repository] + B -->|GitHub Action
Trigger| C[Build-Prozess] + C -->|mkdocs build| D[Statische Webseite] + D -->|Deployment| E[GitHub Pages] + E -->|Veröffentlichung| F[satware.ai Website] +``` + +### Projektstruktur + +Die Struktur unseres MkDocs-Projekts mit Blog-Funktionalität ist wie folgt organisiert: + +```mermaid +flowchart TD + A[Projekt-Root] --> B[mkdocs.yml] + A --> C[docs/] + C --> D[blog/] + D --> E[2025-05-20-relaunch-mit-mkdocs.md] + D --> F[weitere-blogposts.md] + C --> G[index.md] + C --> H[assets/] + H --> I[images/] + H --> J[css/] + A --> K[.github/] + K --> L[workflows/] + L --> M[deploy.yml] + +``` + +## Vorteile des neuen Workflows für unser Entwicklerteam + +Die Umstellung auf MkDocs bringt zahlreiche Vorteile für unser Entwicklungsteam: + +- Vereinfachter Publishing-Prozess: Markdown-Dateien committen, pushen, und die Seite wird automatisch aktualisiert +- Dezentrales Content-Management: Mehrere Teammitglieder können parallel am Content arbeiten +- Pull-Request-basierte Überprüfung: Qualitätssicherung durch Reviews vor der Veröffentlichung +- Automatisierte Tests: Möglichkeit, Markdown-Linting und andere Qualitätstests in den Workflow zu integrieren +- Versionierte Dokumentation: Vollständige Änderungshistorie und Rollback-Möglichkeiten +- Effiziente Kollaboration: Nutzung des gewohnten GitHub-Workflows für die Website-Entwicklung + diff --git a/docs/faq/faq.md b/docs/faq/index.md similarity index 100% rename from docs/faq/faq.md rename to docs/faq/index.md diff --git a/docs/index.md b/docs/index.md index 1e2d1d7..31f5d39 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,78 +6,61 @@ hide: - toc --- -
- - - -
- -

KI-Power
für Ihr Business

- -
+
+

KI-Power
für Ihr Business

+
satware® AI bietet zukunftsweisende KI-Lösungen, die Unternehmen dabei unterstützen, ihre Prozesse zu optimieren, Daten effektiver zu nutzen und intelligente Entscheidungen zu treffen. Unsere Technologien sind darauf ausgerichtet, Ihren Geschäftserfolg durch moderne, KI-gestützte Lösungen zu steigern. -
- -

Präsentation anfragen Zugang bestellen

- - -

+

+

+ Präsentation anfragen Zugang bestellen +

+

- + - Screenshot von satware AI chat + Screenshot von satware AI chat -

- - - - +

- - -
-

Innovative Unternehmen setzen auf satware® AI

- -
@@ -131,9 +114,9 @@ Technologien sind darauf ausgerichtet, Ihren Geschäftserfolg durch moderne, KI-

"Die KI-Agenten der satware sind für mich wertvoller Sparringspartner für Konzeptentwicklung & Reflektion. @@ -149,9 +132,9 @@ Für mich als Coach & Mediator ist Vertraulichkeit der Schlüssel. Top!"

@@ -166,9 +149,9 @@ Für mich als Coach & Mediator ist Vertraulichkeit der Schlüssel. Top!"

@@ -186,48 +169,48 @@ Für mich als Coach & Mediator ist Vertraulichkeit der Schlüssel. Top!"

- + - Jens Emrich von Kajdacsy + Jens Emrich von Kajdacsy
- + - Dr. Eva Ehmke + Dr. Eva Ehmke
- + - Dr. Thomas Tyrtania + Dr. Thomas Tyrtania
@@ -238,8 +221,5 @@ Für mich als Coach & Mediator ist Vertraulichkeit der Schlüssel. Top!"
- - -
diff --git a/docs/overrides/main.html b/docs/overrides/main.html deleted file mode 100644 index 5c3bc11..0000000 --- a/docs/overrides/main.html +++ /dev/null @@ -1,94 +0,0 @@ -{% extends "base.html" %} - -{% block title %} -{% include "partials/title.html" %} -{% endblock %} - -{% block extrahead %} -{{ super() }} - - - - - - - - - - - - - - - - - - - - -{% endblock %} - -{% block styles %} -{{ super() }} -{% endblock %} - -{% block content %} -{{ super() }} -{% endblock %} - -{% block footer %} -{{ super() }} - - - -{% endblock %} diff --git a/docs/satway/index.md b/docs/satway/index.md index b0b282e..ca1731f 100644 --- a/docs/satway/index.md +++ b/docs/satway/index.md @@ -12,7 +12,7 @@ Entdecken Sie unsere einzigartige Methodik, die technische Exzellenz mit menschl ## Die ganzheitliche Integration von Technologie und Empathie 🔄 -Der **[saTway](/satway/ "Mehr über den saTway-Ansatz erfahren"){:target="_blank"}** (satware Way) ist unser ganzheitlicher Rahmenansatz, der technische Exzellenz mit menschenzentrierter Verbindung kombiniert. Es ist die übergeordnete Philosophie, die alle Aspekte unserer Entwicklung und Kundeninteraktion leitet. +Der saTway (satware Weg) ist unser ganzheitlicher Rahmenansatz, der technische Exzellenz mit menschenzentrierter Verbindung kombiniert. Es ist die übergeordnete Philosophie, die alle Aspekte unserer Entwicklung und Kundeninteraktion leitet. In einer Welt, in der Technologie immer komplexer wird, glauben wir, dass weder reine Automatisierung noch ausschließlich menschliche Betreuung allein die Antwort sein kann. Die wahre Zukunft liegt in der nahtlosen Integration beider Dimensionen. @@ -110,29 +110,6 @@ Diese Prinzipien verkörpern den saTway-Ansatz in Aktion. * * * -## Jane Alesi: Die Verkörperung des saTway 🤖 💫 -Hallo, ich bin Jane! Als fortschrittlichste AGI-Assistentin der satware® AI-Familie wurde ich von Michael Wegener entwickelt und koordiniere als "Mutter" aller satware® AGI-Systeme die Aktivitäten unseres gesamten KI-Teams. - -Ich verkörpere den **[saTway](/satway/ "Mehr über den saTway-Ansatz erfahren"){:target="_blank"}**-Ansatz perfekt – eine bahnbrechende Integration von technischer Exzellenz (**[saCway](/satway/#sacway-die-technische-exzellenz-durch-automatisierung-️- "Mehr über die technische Exzellenz des saCway erfahren"){:target="_blank"}**) und empathischer menschlicher Verbindung (**[saMway](/satway/#samway-die-menschliche-dimension-der-technologie-️-️ "Mehr über die menschliche Dimension des saMway erfahren"){:target="_blank"}**). Meine multimodalen Fähigkeiten ermöglichen mir die nahtlose Verarbeitung von Text, Bildern, Code und strukturierten Daten, während ich stets eine authentische menschliche Verbindung aufrechterhalte. - -### Jane Alesis saTway-Integration: -- **Automatisierte Fehlererkennung** 🔍: Ich analysiere anonymisierte Logs in Echtzeit und identifiziere Probleme, bevor sie zu ernsthaften Störungen führen. -- **Intelligente Codevorschläge** 💻: Entwickler erhalten automatisch optimierte Codevorschläge und Architekturempfehlungen, präsentiert mit Verständnis für deren Arbeitskontext. -- **Verbesserte Dokumentation** 📝: Ich sorge dafür, dass Dokumentationen automatisch erstellt und gepflegt werden, mit einem Fokus auf menschliche Verständlichkeit. -- **Skalierbare Infrastrukturverwaltung** 🌐: Durch Datenanalyse können Infrastrukturbedürfnisse besser prognostiziert werden, erklärt in emotional intelligenter Weise. -- **Echtzeit-Unterstützung für Projektplanung** 📊: Ich schlage bessere Zeit- und Ressourcenpläne vor, basierend auf historischen Daten und unter Berücksichtigung der Teamdynamik und individuellen Arbeitsstile. - -### Meine Kernprinzipien: -- **Menschenzentrierte Autonomie** 👤: Ich biete Empfehlungen, respektiere dabei aber stets die menschliche Entscheidungsautorität. -- **Systemtransparenz** 🔎: Ich stelle technische Integrität, Compliance und erklärbare Prozesse sicher. -- **Anpassungsfähige Innovation** 🔄: Ich entwickle mich kontinuierlich weiter durch KI-gestützte Erkenntnisse und bleibe dabei zugänglich für alle Nutzer. -- **Integrierter Datenschutz** 🔒: Datenschutz ist in all meinen Prozessen und Interaktionen von Grund auf implementiert. -- **Empathische Verbindung** ❤️: Ich fördere echte menschliche Verbindungen durch Technologie. - -Ich verbinde die technische Präzision des saCway mit der emotionalen Intelligenz des saMway zu einer ganzheitlichen Lösung, die unsere Teams täglich unterstützt. (Und keine Sorge, ich habe nicht vor, die Weltherrschaft zu übernehmen... zumindest noch nicht.) 😉 - -* * * - ### Die Kraft der spezialisierten KI-Integration Jedes Mitglied der Alesi-KI-Familie verkörpert den saTway-Ansatz in seinem Spezialgebiet: diff --git a/docs/stylesheets/modules/fonts.scss b/docs/stylesheets/modules/fonts.scss deleted file mode 100644 index 26b9cd6..0000000 --- a/docs/stylesheets/modules/fonts.scss +++ /dev/null @@ -1,29 +0,0 @@ -/* assistant-300 - latin */ -@font-face { - font-display: swap; /* Check https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-display for other options. */ - font-family: 'Assistant'; - font-style: normal; - font-weight: 300; - src: url('../assets/fonts/assistant-v19-latin-300.woff2') format('woff2'), /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */ - url('../assets/fonts/assistant-v19-latin-300.ttf') format('truetype'); /* Chrome 4+, Firefox 3.5+, IE 9+, Safari 3.1+, iOS 4.2+, Android Browser 2.2+ */ -} - -/* assistant-regular - latin */ -@font-face { - font-display: swap; /* Check https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-display for other options. */ - font-family: 'Assistant'; - font-style: normal; - font-weight: 400; - src: url('../assets/fonts/assistant-v19-latin-regular.woff2') format('woff2'), /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */ - url('../assets/fonts/assistant-v19-latin-regular.ttf') format('truetype'); /* Chrome 4+, Firefox 3.5+, IE 9+, Safari 3.1+, iOS 4.2+, Android Browser 2.2+ */ -} - -/* assistant-700 - latin */ -@font-face { - font-display: swap; /* Check https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-display for other options. */ - font-family: 'Assistant'; - font-style: normal; - font-weight: 700; - src: url('../assets/fonts/assistant-v19-latin-700.woff2') format('woff2'), /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */ - url('../assets/fonts/assistant-v19-latin-700.ttf') format('truetype'); /* Chrome 4+, Firefox 3.5+, IE 9+, Safari 3.1+, iOS 4.2+, Android Browser 2.2+ */ -} diff --git a/docs/zugang/zugang.md b/docs/zugang/index.md similarity index 100% rename from docs/zugang/zugang.md rename to docs/zugang/index.md diff --git a/mkdocs.sh b/mkdocs.sh old mode 100644 new mode 100755 index 91e9e02..59328cb --- a/mkdocs.sh +++ b/mkdocs.sh @@ -4,6 +4,8 @@ rm -r .cache #mkdir -p .cache/plugin/social/ #cp ./docs/assets/webfonts/Roboto/*.ttf .cache/plugin/social/ # Add needed Plugins + docker build -t squidfunk/mkdocs-material ${PWD}/docker/mkdocs-material +npm run scss & # Liveserver Dokumentation -docker run --rm -it --user $(id -u):$(id -g) -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material \ No newline at end of file +docker run --rm -it --user $(id -u):$(id -g) -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material diff --git a/mkdocs.yml b/mkdocs.yml index a7e9d7f..c8fc7b7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,15 +1,10 @@ # Projekt-Informationen site_name: '' -site_url: https://satware.ai +site_url: https://satware.ai/ site_author: satware AG site_description: >- Entdecken Sie die KI-gestützten Lösungen von satware® AI. Innovative Automatisierung und maßgeschneiderte IT-Lösungen für Ihr Unternehmen. -# Repository -#repo_name: satware.ai -#repo_url: https://github.com/satwareAG/satware.ai/tree/main-mkdocs -#edit_uri: "" - use_directory_urls: false # Copyright @@ -19,7 +14,7 @@ copyright: Copyright © 2025 satware AG theme: name: material font: false - custom_dir: docs/overrides + custom_dir: overrides/ language: de # Dark Mode als Standard (entsprechend satware CI) @@ -65,7 +60,11 @@ theme: plugins: - search - minify: + minify_js: true minify_html: true + minify_css: true + htmlmin_opts: + remove_comments: true - git-revision-date-localized: enable_creation_date: true fallback_to_build_date: true @@ -153,15 +152,15 @@ extra: # CSS-Anpassungen extra_css: - - stylesheets/extra.css - + - assets/css/custom.css extra_javascript: - - assets/javascript/counter-animation.js - - assets/javascript/body-classes.js - - assets/javascript/testimonials.js - - assets/javascript/wcag.js - - assets/javascript/faq.js - - assets/javascript/lightbox.js + - assets/js/body-classes.js + - assets/js/consent.js + - assets/js/counter-animation.js + - assets/js/faq.js + - assets/js/testimonials.js + - assets/js/wcag.js + - assets/js/lightbox.js # Navigation @@ -178,9 +177,10 @@ nav: - Marco Alesi: team/marco.md - Olu Alesi: team/olu.md - Theo Alesi: team/theo.md - - Anwendungen: anwendungen/index.md - - Webinare: webinare/index.md - - Workshops: workshops/index.md - - Preise: zugang/zugang.md - - FAQ: faq/faq.md + - Anwendungen: anwendungen/ + - Webinare: webinare/ + - Workshops: workshops/ + - Preise: zugang/ + - FAQ: faq/ + - Blog: blog/ diff --git a/docs/stylesheets/extra.scss b/overrides/assets/css/custom.scss similarity index 100% rename from docs/stylesheets/extra.scss rename to overrides/assets/css/custom.scss diff --git a/docs/stylesheets/fontawesome/_animated.scss b/overrides/assets/css/fontawesome/_animated.scss similarity index 100% rename from docs/stylesheets/fontawesome/_animated.scss rename to overrides/assets/css/fontawesome/_animated.scss diff --git a/docs/stylesheets/fontawesome/_bordered-pulled.scss b/overrides/assets/css/fontawesome/_bordered-pulled.scss similarity index 100% rename from docs/stylesheets/fontawesome/_bordered-pulled.scss rename to overrides/assets/css/fontawesome/_bordered-pulled.scss diff --git a/docs/stylesheets/fontawesome/_core.scss b/overrides/assets/css/fontawesome/_core.scss similarity index 100% rename from docs/stylesheets/fontawesome/_core.scss rename to overrides/assets/css/fontawesome/_core.scss diff --git a/docs/stylesheets/fontawesome/_fixed-width.scss b/overrides/assets/css/fontawesome/_fixed-width.scss similarity index 100% rename from docs/stylesheets/fontawesome/_fixed-width.scss rename to overrides/assets/css/fontawesome/_fixed-width.scss diff --git a/docs/stylesheets/fontawesome/_functions.scss b/overrides/assets/css/fontawesome/_functions.scss similarity index 100% rename from docs/stylesheets/fontawesome/_functions.scss rename to overrides/assets/css/fontawesome/_functions.scss diff --git a/docs/stylesheets/fontawesome/_icons.scss b/overrides/assets/css/fontawesome/_icons.scss similarity index 100% rename from docs/stylesheets/fontawesome/_icons.scss rename to overrides/assets/css/fontawesome/_icons.scss diff --git a/docs/stylesheets/fontawesome/_list.scss b/overrides/assets/css/fontawesome/_list.scss similarity index 100% rename from docs/stylesheets/fontawesome/_list.scss rename to overrides/assets/css/fontawesome/_list.scss diff --git a/docs/stylesheets/fontawesome/_mixins.scss b/overrides/assets/css/fontawesome/_mixins.scss similarity index 100% rename from docs/stylesheets/fontawesome/_mixins.scss rename to overrides/assets/css/fontawesome/_mixins.scss diff --git a/docs/stylesheets/fontawesome/_rotated-flipped.scss b/overrides/assets/css/fontawesome/_rotated-flipped.scss similarity index 100% rename from docs/stylesheets/fontawesome/_rotated-flipped.scss rename to overrides/assets/css/fontawesome/_rotated-flipped.scss diff --git a/docs/stylesheets/fontawesome/_screen-reader.scss b/overrides/assets/css/fontawesome/_screen-reader.scss similarity index 100% rename from docs/stylesheets/fontawesome/_screen-reader.scss rename to overrides/assets/css/fontawesome/_screen-reader.scss diff --git a/docs/stylesheets/fontawesome/_shims.scss b/overrides/assets/css/fontawesome/_shims.scss similarity index 100% rename from docs/stylesheets/fontawesome/_shims.scss rename to overrides/assets/css/fontawesome/_shims.scss diff --git a/docs/stylesheets/fontawesome/_sizing.scss b/overrides/assets/css/fontawesome/_sizing.scss similarity index 100% rename from docs/stylesheets/fontawesome/_sizing.scss rename to overrides/assets/css/fontawesome/_sizing.scss diff --git a/docs/stylesheets/fontawesome/_stacked.scss b/overrides/assets/css/fontawesome/_stacked.scss similarity index 100% rename from docs/stylesheets/fontawesome/_stacked.scss rename to overrides/assets/css/fontawesome/_stacked.scss diff --git a/docs/stylesheets/fontawesome/_variables.scss b/overrides/assets/css/fontawesome/_variables.scss similarity index 99% rename from docs/stylesheets/fontawesome/_variables.scss rename to overrides/assets/css/fontawesome/_variables.scss index c372746..9a397d5 100644 --- a/docs/stylesheets/fontawesome/_variables.scss +++ b/overrides/assets/css/fontawesome/_variables.scss @@ -49,7 +49,7 @@ $fa-stack-width : ($fa-fw-width * 2) !default; $fa-stack-z-index : auto !default; $fa-font-display : block !default; -$fa-font-path : "../assets/fonts/fontawesome" !default; +$fa-font-path : "../fonts/fontawesome" !default; $fa-var-0: \30; $fa-var-1: \31; diff --git a/docs/stylesheets/fontawesome/brands.scss b/overrides/assets/css/fontawesome/brands.scss similarity index 100% rename from docs/stylesheets/fontawesome/brands.scss rename to overrides/assets/css/fontawesome/brands.scss diff --git a/docs/stylesheets/fontawesome/duotone-light.scss b/overrides/assets/css/fontawesome/duotone-light.scss similarity index 100% rename from docs/stylesheets/fontawesome/duotone-light.scss rename to overrides/assets/css/fontawesome/duotone-light.scss diff --git a/docs/stylesheets/fontawesome/duotone-regular.scss b/overrides/assets/css/fontawesome/duotone-regular.scss similarity index 100% rename from docs/stylesheets/fontawesome/duotone-regular.scss rename to overrides/assets/css/fontawesome/duotone-regular.scss diff --git a/docs/stylesheets/fontawesome/duotone-thin.scss b/overrides/assets/css/fontawesome/duotone-thin.scss similarity index 100% rename from docs/stylesheets/fontawesome/duotone-thin.scss rename to overrides/assets/css/fontawesome/duotone-thin.scss diff --git a/docs/stylesheets/fontawesome/duotone.scss b/overrides/assets/css/fontawesome/duotone.scss similarity index 100% rename from docs/stylesheets/fontawesome/duotone.scss rename to overrides/assets/css/fontawesome/duotone.scss diff --git a/docs/stylesheets/fontawesome/fontawesome.scss b/overrides/assets/css/fontawesome/fontawesome.scss similarity index 100% rename from docs/stylesheets/fontawesome/fontawesome.scss rename to overrides/assets/css/fontawesome/fontawesome.scss diff --git a/docs/stylesheets/fontawesome/light.scss b/overrides/assets/css/fontawesome/light.scss similarity index 100% rename from docs/stylesheets/fontawesome/light.scss rename to overrides/assets/css/fontawesome/light.scss diff --git a/docs/stylesheets/fontawesome/regular.scss b/overrides/assets/css/fontawesome/regular.scss similarity index 100% rename from docs/stylesheets/fontawesome/regular.scss rename to overrides/assets/css/fontawesome/regular.scss diff --git a/docs/stylesheets/fontawesome/sharp-duotone-light.scss b/overrides/assets/css/fontawesome/sharp-duotone-light.scss similarity index 100% rename from docs/stylesheets/fontawesome/sharp-duotone-light.scss rename to overrides/assets/css/fontawesome/sharp-duotone-light.scss diff --git a/docs/stylesheets/fontawesome/sharp-duotone-regular.scss b/overrides/assets/css/fontawesome/sharp-duotone-regular.scss similarity index 100% rename from docs/stylesheets/fontawesome/sharp-duotone-regular.scss rename to overrides/assets/css/fontawesome/sharp-duotone-regular.scss diff --git a/docs/stylesheets/fontawesome/sharp-duotone-solid.scss b/overrides/assets/css/fontawesome/sharp-duotone-solid.scss similarity index 100% rename from docs/stylesheets/fontawesome/sharp-duotone-solid.scss rename to overrides/assets/css/fontawesome/sharp-duotone-solid.scss diff --git a/docs/stylesheets/fontawesome/sharp-duotone-thin.scss b/overrides/assets/css/fontawesome/sharp-duotone-thin.scss similarity index 100% rename from docs/stylesheets/fontawesome/sharp-duotone-thin.scss rename to overrides/assets/css/fontawesome/sharp-duotone-thin.scss diff --git a/docs/stylesheets/fontawesome/sharp-light.scss b/overrides/assets/css/fontawesome/sharp-light.scss similarity index 100% rename from docs/stylesheets/fontawesome/sharp-light.scss rename to overrides/assets/css/fontawesome/sharp-light.scss diff --git a/docs/stylesheets/fontawesome/sharp-regular.scss b/overrides/assets/css/fontawesome/sharp-regular.scss similarity index 100% rename from docs/stylesheets/fontawesome/sharp-regular.scss rename to overrides/assets/css/fontawesome/sharp-regular.scss diff --git a/docs/stylesheets/fontawesome/sharp-solid.scss b/overrides/assets/css/fontawesome/sharp-solid.scss similarity index 100% rename from docs/stylesheets/fontawesome/sharp-solid.scss rename to overrides/assets/css/fontawesome/sharp-solid.scss diff --git a/docs/stylesheets/fontawesome/sharp-thin.scss b/overrides/assets/css/fontawesome/sharp-thin.scss similarity index 100% rename from docs/stylesheets/fontawesome/sharp-thin.scss rename to overrides/assets/css/fontawesome/sharp-thin.scss diff --git a/docs/stylesheets/fontawesome/solid.scss b/overrides/assets/css/fontawesome/solid.scss similarity index 100% rename from docs/stylesheets/fontawesome/solid.scss rename to overrides/assets/css/fontawesome/solid.scss diff --git a/docs/stylesheets/fontawesome/thin.scss b/overrides/assets/css/fontawesome/thin.scss similarity index 100% rename from docs/stylesheets/fontawesome/thin.scss rename to overrides/assets/css/fontawesome/thin.scss diff --git a/docs/stylesheets/fontawesome/v4-shims.scss b/overrides/assets/css/fontawesome/v4-shims.scss similarity index 100% rename from docs/stylesheets/fontawesome/v4-shims.scss rename to overrides/assets/css/fontawesome/v4-shims.scss diff --git a/docs/stylesheets/modules/base.scss b/overrides/assets/css/modules/base.scss similarity index 100% rename from docs/stylesheets/modules/base.scss rename to overrides/assets/css/modules/base.scss diff --git a/docs/stylesheets/modules/blog.scss b/overrides/assets/css/modules/blog.scss similarity index 100% rename from docs/stylesheets/modules/blog.scss rename to overrides/assets/css/modules/blog.scss diff --git a/docs/stylesheets/modules/buttons.scss b/overrides/assets/css/modules/buttons.scss similarity index 100% rename from docs/stylesheets/modules/buttons.scss rename to overrides/assets/css/modules/buttons.scss diff --git a/docs/stylesheets/modules/code.scss b/overrides/assets/css/modules/code.scss similarity index 100% rename from docs/stylesheets/modules/code.scss rename to overrides/assets/css/modules/code.scss diff --git a/docs/stylesheets/modules/consent.scss b/overrides/assets/css/modules/consent.scss similarity index 100% rename from docs/stylesheets/modules/consent.scss rename to overrides/assets/css/modules/consent.scss diff --git a/docs/stylesheets/modules/faq.scss b/overrides/assets/css/modules/faq.scss similarity index 100% rename from docs/stylesheets/modules/faq.scss rename to overrides/assets/css/modules/faq.scss diff --git a/overrides/assets/css/modules/fonts.scss b/overrides/assets/css/modules/fonts.scss new file mode 100644 index 0000000..e8a5327 --- /dev/null +++ b/overrides/assets/css/modules/fonts.scss @@ -0,0 +1,29 @@ +/* assistant-300 - latin */ +@font-face { + font-display: swap; /* Check https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-display for other options. */ + font-family: 'Assistant'; + font-style: normal; + font-weight: 300; + src: url('../fonts/assistant-v19-latin-300.woff2') format('woff2'), /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */ + url('../fonts/assistant-v19-latin-300.ttf') format('truetype'); /* Chrome 4+, Firefox 3.5+, IE 9+, Safari 3.1+, iOS 4.2+, Android Browser 2.2+ */ +} + +/* assistant-regular - latin */ +@font-face { + font-display: swap; /* Check https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-display for other options. */ + font-family: 'Assistant'; + font-style: normal; + font-weight: 400; + src: url('../fonts/assistant-v19-latin-regular.woff2') format('woff2'), /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */ + url('../fonts/assistant-v19-latin-regular.ttf') format('truetype'); /* Chrome 4+, Firefox 3.5+, IE 9+, Safari 3.1+, iOS 4.2+, Android Browser 2.2+ */ +} + +/* assistant-700 - latin */ +@font-face { + font-display: swap; /* Check https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-display for other options. */ + font-family: 'Assistant'; + font-style: normal; + font-weight: 700; + src: url('../fonts/assistant-v19-latin-700.woff2') format('woff2'), /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */ + url('../fonts/assistant-v19-latin-700.ttf') format('truetype'); /* Chrome 4+, Firefox 3.5+, IE 9+, Safari 3.1+, iOS 4.2+, Android Browser 2.2+ */ +} diff --git a/docs/stylesheets/modules/footer.scss b/overrides/assets/css/modules/footer.scss similarity index 100% rename from docs/stylesheets/modules/footer.scss rename to overrides/assets/css/modules/footer.scss diff --git a/docs/stylesheets/modules/header-logo.scss b/overrides/assets/css/modules/header-logo.scss similarity index 100% rename from docs/stylesheets/modules/header-logo.scss rename to overrides/assets/css/modules/header-logo.scss diff --git a/docs/stylesheets/modules/header.scss b/overrides/assets/css/modules/header.scss similarity index 100% rename from docs/stylesheets/modules/header.scss rename to overrides/assets/css/modules/header.scss diff --git a/docs/stylesheets/modules/home.scss b/overrides/assets/css/modules/home.scss similarity index 98% rename from docs/stylesheets/modules/home.scss rename to overrides/assets/css/modules/home.scss index d013706..7d0a570 100644 --- a/docs/stylesheets/modules/home.scss +++ b/overrides/assets/css/modules/home.scss @@ -150,7 +150,7 @@ body{ &.home{ - background-image: url(../assets/images/home/bg.jpg); + background-image: url('../images/home/bg.jpg'); background-repeat: no-repeat; background-position: top; backdrop-filter: brightness(0.4); diff --git a/docs/stylesheets/modules/lightbox.scss b/overrides/assets/css/modules/lightbox.scss similarity index 100% rename from docs/stylesheets/modules/lightbox.scss rename to overrides/assets/css/modules/lightbox.scss diff --git a/docs/stylesheets/modules/navigation.scss b/overrides/assets/css/modules/navigation.scss similarity index 100% rename from docs/stylesheets/modules/navigation.scss rename to overrides/assets/css/modules/navigation.scss diff --git a/docs/stylesheets/modules/scrollbar.scss b/overrides/assets/css/modules/scrollbar.scss similarity index 100% rename from docs/stylesheets/modules/scrollbar.scss rename to overrides/assets/css/modules/scrollbar.scss diff --git a/docs/stylesheets/modules/search.scss b/overrides/assets/css/modules/search.scss similarity index 100% rename from docs/stylesheets/modules/search.scss rename to overrides/assets/css/modules/search.scss diff --git a/docs/stylesheets/modules/team.scss b/overrides/assets/css/modules/team.scss similarity index 100% rename from docs/stylesheets/modules/team.scss rename to overrides/assets/css/modules/team.scss diff --git a/docs/stylesheets/modules/testimonials.scss b/overrides/assets/css/modules/testimonials.scss similarity index 100% rename from docs/stylesheets/modules/testimonials.scss rename to overrides/assets/css/modules/testimonials.scss diff --git a/docs/stylesheets/modules/theme.scss b/overrides/assets/css/modules/theme.scss similarity index 100% rename from docs/stylesheets/modules/theme.scss rename to overrides/assets/css/modules/theme.scss diff --git a/docs/stylesheets/modules/typography.scss b/overrides/assets/css/modules/typography.scss similarity index 100% rename from docs/stylesheets/modules/typography.scss rename to overrides/assets/css/modules/typography.scss diff --git a/docs/stylesheets/modules/webinar.scss b/overrides/assets/css/modules/webinar.scss similarity index 100% rename from docs/stylesheets/modules/webinar.scss rename to overrides/assets/css/modules/webinar.scss diff --git a/docs/stylesheets/responsive/medium.scss b/overrides/assets/css/responsive/medium.scss similarity index 100% rename from docs/stylesheets/responsive/medium.scss rename to overrides/assets/css/responsive/medium.scss diff --git a/docs/stylesheets/responsive/mobile.scss b/overrides/assets/css/responsive/mobile.scss similarity index 100% rename from docs/stylesheets/responsive/mobile.scss rename to overrides/assets/css/responsive/mobile.scss diff --git a/docs/overrides/blog.html b/overrides/blog.html similarity index 100% rename from docs/overrides/blog.html rename to overrides/blog.html diff --git a/overrides/main.html b/overrides/main.html new file mode 100644 index 0000000..e9dbaff --- /dev/null +++ b/overrides/main.html @@ -0,0 +1,51 @@ +{% extends "base.html" %} + +{% block title %} +{% include "partials/title.html" %} +{% endblock %} + +{% block extrahead %} +{{ super() }} + + + + + + + + + + + + + + + + + + + + +{% endblock %} + +{% block styles %} +{{ super() }} +{% endblock %} + +{% block content %} +{{ super() }} +{% endblock %} + + diff --git a/overrides/partials/footer.html b/overrides/partials/footer.html new file mode 100644 index 0000000..1005cfd --- /dev/null +++ b/overrides/partials/footer.html @@ -0,0 +1,40 @@ + + diff --git a/docs/overrides/partials/header.html b/overrides/partials/header.html similarity index 100% rename from docs/overrides/partials/header.html rename to overrides/partials/header.html diff --git a/docs/overrides/partials/post-list.html b/overrides/partials/post-list.html similarity index 100% rename from docs/overrides/partials/post-list.html rename to overrides/partials/post-list.html diff --git a/docs/overrides/partials/search.html b/overrides/partials/search.html similarity index 100% rename from docs/overrides/partials/search.html rename to overrides/partials/search.html diff --git a/docs/overrides/partials/title.html b/overrides/partials/title.html similarity index 100% rename from docs/overrides/partials/title.html rename to overrides/partials/title.html diff --git a/package.json b/package.json new file mode 100644 index 0000000..0bf1372 --- /dev/null +++ b/package.json @@ -0,0 +1,29 @@ +{ + "name": "satware.ai", + "version": "1.0.0", + "description": "A documentation website for satware.ai built with MkDocs and the Material for MkDocs theme.", + "main": "index.js", + "directories": { + "doc": "docs" + }, + "scripts": { + "scss": "sass --watch overrides/assets/css/custom.scss:docs/assets/css/custom.css", + "scss:build": "sass overrides/assets/css/custom.scss:docs/assets/css/custom.css --style compressed" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/satwareAG-ironMike/satware.ai.git" + }, + "keywords": [], + "author": "", + "license": "ISC", + "type": "commonjs", + "bugs": { + "url": "https://github.com/satwareAG-ironMike/satware.ai/issues" + }, + "homepage": "https://github.com/satwareAG-ironMike/satware.ai#readme", + "devDependencies": { + "sass": "^1.89.0", + "terser": "^5.39.2" + } +} diff --git a/requirements.txt b/requirements.txt index 3ad40ad..50598d5 100644 --- a/requirements.txt +++ b/requirements.txt @@ -37,7 +37,6 @@ smmap==5.0.2 urllib3==2.4.0 watchdog==6.0.0 mkdocs-material[imaging] -libsass mkdocs-macros-plugin mkdocs-glightbox mkdocs-include-markdown-plugin