This repository contains the documentation for Siemens industry solutions, built with DocFX.
- TIA Portal - Documentation for Siemens TIA Portal automation software
- WinCC 7.x/8.x - Documentation for WinCC versions 7.x and 8.x
- WinCC Unified - Documentation for WinCC Unified platform
Install DocFX globally:
dotnet tool install -g docfxTo build the documentation:
docfx build docfx.jsonThe generated documentation will be output to the _site/ directory.
To build and preview the documentation locally:
docfx --serveThis will start a local web server, typically at http://localhost:8080.
The documentation is configured via docfx.json:
- Content: Markdown and YAML files from the
articles/directory - Resources: Images and other assets
- Output: Generated documentation in
_site/ - Templates: Uses default, modern, and custom Siemens templates
- Metadata:
- App Title:
docfx-demo - Search: Enabled
- Logo:
images/sie-logo-white-rgb.svg - Favicon:
images/favicon.ico
- App Title:
To add or modify documentation:
- Create or edit markdown files in the
articles/directory - Update the table of contents in
toc.ymlas needed - Add images to
images/or subdirectory-specific image folders - Build locally to verify changes:
docfx build docfx.json - Review the generated documentation in
_site/
Documentation files should use:
- Markdown (
.md) for content pages - YAML (
.yml) for table of contents and metadata
This documentation is part of the Siemens Industry PL knowledge base.
For issues or questions about the documentation, please contact the Siemens Industry documentation team.