mwandGitHub
60ef48d988
* Remove unused font-face definitions from stylesheets The `fonts.scss` file defining `Assistant` font-face rules has been deleted as it was no longer in use. This cleanup reduces unnecessary assets and improves maintainability. * Fix npm script command in blog preview workflow Replaced `npm scss:build` with the correct `npm run scss:build` command in the GitHub Actions workflow. This ensures the SCSS build step executes properly during site generation. * Update blog preview workflow to use mkdocs gh-deploy Replaces the GitHub Pages action with `mkdocs gh-deploy` for deploying previews. Simplifies the workflow configuration and reduces dependencies. * Update `site_url` logic and fix URL format consistency Simplified the `site_url` handling in the workflow by removing branch-specific URL construction. Additionally, ensured the main URL in `mkdocs.yml` uses a consistent trailing slash. This enhances clarity and maintains uniformity in URL formatting. * Set `use_directory_urls` in mkdocs.yml directly. Removed redundant script lines for configuring `use_directory_urls` in the workflow file. This simplifies deployment logic by directly defining the configuration in the mkdocs.yml file. * Remove unnecessary CSS source map file Deleted `custom.css.map` as it is not required for production. Removing it helps reduce clutter and keeps the repository clean. * Add support for 'satware.ai' as a homepage path Updated body-classes.js to treat 'satware.ai' as a homepage path by adding the 'home' class to the body element. This ensures correct behavior for both empty paths and specific developer GitHub Pages. * Simplify FAQ and navigation structure. Renamed `faq.md` to `index.md` for consistency and updated navigation links in `mkdocs.yml` to use folder paths directly. Adjusted `main.html` to clean up formatting with additional line breaks. * Update footer links to use relative paths Replaced absolute paths with relative paths for internal footer links to ensure consistency and improve maintainability. External links remain unchanged. * Fix relative URL for Jane Alesi's team page in authors file Updated the URL path for Jane Alesi to ensure correct navigation to her team page. This fixes a broken link caused by an incorrect relative URL. * Update footer links and enhance blog post on website relaunch Updated footer links to utilize dynamic `config.site_url` for consistent URL routing. Enhanced the blog post for better readability, showcasing the MkDocs implementation, GitHub integration, and use of Mermaid diagrams. * Update footer link and simplify satWay documentation Replaced the "Blog" link in the footer with "satWay Prinzipien" and refined the satWay documentation by removing overly detailed content about Jane Alesi. Additionally, added the Blog section to the site navigation in `mkdocs.yml`. * Update CSS build process in deploy workflow Replaced the Python-based SCSS compilation with an npm-based process. This ensures compatibility with the updated build pipeline and leverages the existing npm tools for CSS processing. * Update deploy-live workflow with CSS build step Added a missing CSS build step in the deploy-live workflow to ensure the static site is built with the correct styles. This ensures consistency in the deployment process and addresses potential style-related issues.
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: