mwandGitHub
887fe536d6
* **Remove Python SCSS compiler and development script** - Deleted `compile_scss.py` and `dev.sh` scripts to clean up unused SCSS compilation and local development workflow. - Streamlining project by removing legacy Python-based tooling. Clear shift toward alternative CSS build processes in workflows. * Migrate SCSS compilation to Python-based workflow and simplify Dockerfile - Replaced Node.js SCSS tools with libsass and introduced `scss_watcher.py` for automated SCSS compilation during development. - Updated Dockerfile to use Python-based dependencies and removed redundant npm configuration. - Cleaned up `package.json`, `requirements.txt`, and outdated scripts to streamline the project. - Enhanced development workflow with a lightweight Python-based approach. * Replace `python -m sass` with `pysassc` for SCSS compilation in development scripts * **Refactor and streamline MkDocs workflows, footer, and blog structure** - Removed outdated `deploy-preview-fix.yml` and `deploy-test.yml` workflows for cleanup. - Enhanced `deploy-preview.yml`: - Expanded branch triggers to include `build/**`, `test/**`, and `preview/**`. - Improved `site_url` logic by standardizing URL formatting. - Updated `mkdocs.yml` navigation to use consistent `index.md` file naming. - Simplified footer template to use relative paths for internal links (e.g., `impressum/`, `datenschutz/`). - Adjusted `mkdocs.sh` to ensure SCSS watcher includes `overrides`. - Deleted outdated `Sequential Thinking` blog and branch documentation for better maintenance. * Update to Python 3.13 and streamline MkDocs workflows - Upgraded Dockerfile base image to `python:3.13-slim-bullseye` for consistency with the latest Python version. - Consolidated MkDocs and plugin installation steps in `deploy-preview.yml`. - Replaced Node.js SCSS tools with Python `pysassc` for CSS build process, removing unnecessary npm steps. * Replace `mkdocs-lightbox` with `mkdocs-glightbox` and improve CSS build step in GitHub Actions workflow - Updated `deploy-preview.yml` to switch from `mkdocs-lightbox` to `mkdocs-glightbox` for better compatibility and features. - Enhanced CSS build logic to create the target directory (`docs/assets/css`) if it does not exist, ensuring a smoother workflow execution. * Streamline deploy workflows and enhance CSS build process - Added repository-specific condition to `deploy-live.yml` for improved workflow targeting. - Consolidated MkDocs and plugin installation steps in `deploy-live.yml` to remove redundant tasks. - Enhanced CSS build step to ensure target directory creation (`mkdir -p docs/assets/css`) in both workflows.
satwareai-mkdocs
A documentation website for satware.ai built with MkDocs and the Material for MkDocs theme.
Overview
This project contains the source files for the satware.ai documentation website. It uses MkDocs as the static site generator and the Material for MkDocs theme for styling and enhanced functionality.
Setup and Installation
-
Clone the repository:
git clone https://github.com/satware-ag/satwareai-mkdocs.git cd satwareai-mkdocs -
Create and activate a virtual environment:
python -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate -
Install the dependencies:
pip install -r requirements.txt
Development
To start the development server:
./dev.sh
Or manually:
mkdocs serve
This will start a local development server at http://127.0.0.1:8000/ that automatically reloads when you make changes to the documentation.
SCSS Compilation
The project uses SCSS for styling. To compile SCSS files to CSS:
python compile_scss.py
Building the Site
To build the static site:
mkdocs build
This will create a site directory with the built static site.
Theme Customization
The site uses the Material for MkDocs theme with custom overrides located in the docs/overrides directory. Additional styling is provided through SCSS files in the docs/stylesheets directory.
Documentation
For more information about MkDocs and the Material for MkDocs theme, refer to: