0d1de78799
* Update .gitignore to include custom.css.map Added a reference to custom.css.map to prevent it from being tracked by Git. This helps avoid committing autogenerated files and keeps the repository clean. * Fix layout issues for iPad and tablet landscape view Updated responsive styles to ensure proper visibility and alignment of header elements and navigation on devices with widths between 768px and 1220px. Adjusted logo, spacing, font sizes, and layout to improve usability and appearance. Disabled the hamburger menu to avoid conflicts in this viewport range. * Fix layout issues for iPad and tablet landscape view Updated responsive styles to ensure proper visibility and alignment of header elements and navigation on devices with widths between 768px and 1220px. Adjusted logo, spacing, font sizes, and layout to improve usability and appearance. Disabled the hamburger menu to avoid conflicts in this viewport range. * Add workflow_dispatch trigger to preview workflows Enable manual execution for preview deployment workflows by adding the `workflow_dispatch` trigger. This allows users to start the workflows manually when necessary, improving flexibility and control. * Set default font to "Assistant" in base.scss Removed an unnecessary comment and ensured the root uses "Assistant" as the default font. This improves code clarity while maintaining consistent styling. --------- Co-authored-by: Tim Friedrich Weber <tfw@satware.com>
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: