https://github.com/yaegashi/mkdocs-github-release-assets-plugin

MkDocs plugin to include GitHub release assets in the documentation
https://github.com/yaegashi/mkdocs-github-release-assets-plugin

github-release mkdocs mkdocs-plugin

Last synced: 3 months ago
JSON representation

MkDocs plugin to include GitHub release assets in the documentation

• Host: GitHub
• URL: https://github.com/yaegashi/mkdocs-github-release-assets-plugin
• Owner: yaegashi
• License: mit
• Created: 2024-08-16T01:26:28.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-08-22T16:47:24.000Z (8 months ago)
• Last Synced: 2025-01-30T16:43:41.183Z (3 months ago)
• Topics: github-release, mkdocs, mkdocs-plugin
• Language: Python
• Homepage:
• Size: 2.88 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MkDocs github-release-assets plugin

[![GitHub Pages](https://img.shields.io/badge/pages-documentation-green?logo=github)](https://yaegashi.github.io/mkdocs-github-release-assets-plugin/)

[![GitHub Release](https://img.shields.io/github/v/release/yaegashi/mkdocs-github-release-assets-plugin?logo=github)](https://github.com/yaegashi/mkdocs-github-release-assets-plugin/releases/latest)

[![PyPI](https://img.shields.io/pypi/v/mkdocs-github-release-assets-plugin?logo=pypi)](https://pypi.org/project/mkdocs-github-release-assets-plugin/)

## Introduction

MkDocs plugin to include GitHub releases and assets in the documentation.

This allows you to make private software releases available to non-dev people who don't have access to the dev repository.

It is designed to be used with [Backstage TechDocs](https://backstage.io/docs/features/techdocs/) to create distribution sites within internal developer portals.

The following screenshot is generated from [v0.0.2 release and assets](https://github.com/yaegashi/mkdocs-github-release-assets-plugin/releases/tag/v0.0.2).

![](https://raw.githubusercontent.com/yaegashi/mkdocs-github-release-assets-plugin/main/docs/assets/ss1.png)