GitLab CI/CD Components for Markdown and PDF Processing

Documentation · Report Bug · Request Feature

Table of Contents

• Table of Contents
• Overview
• Usage
• Contributing
• Support
• License

Overview

This project provides GitLab CI/CD components for processing Markdown files into PDFs, validating Markdown quality, and creating web views. The components include:

1. PDF UA Generation Component: Converts Markdown files to PDF while ensuring PDF/UA compliance.
2. Markdown Quality Check Component: Validates the quality of Markdown files, including link reachability, and provides GitLab Code-Quality widgets.
3. Web View Light Component: Generate a web view of Markdown files and publish the result as a GitLab page.
4. Web View Full Component: Generate a web view of Markdown files and pushes the resulting container to a registry with additional features.

These components are used in the IT-Architekturrichtlinien repositories as an example.

Happy PDF building, Markdown validation, and webview generation with GitLab CI/CD!

Usage

Please refer to the documentation (de) for detailed instructions on using the components.

Contributing

Contributions are welcome! Please:

• Read the Contributing Guidelines.
• Sign the Contributor License Agreement.
• Follow the Code of Conduct.

Support

If you encounter issues or have questions, please open an issue in this repository or contact the maintainers.

• Report a Bug
• Request a Feature

License

This project is licensed under the EUPL 1.2. See the LICENSE.md file for details.