Skip to main content

MkDocs plugin to include GitHub release assets in the documentation

Project description

MkDocs github-release-assets plugin

GitHub Pages GitHub Release PyPI

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 to create distribution sites within internal developer portals.

The following screenshot is generated from v0.0.2 release and assets.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file mkdocs_github_release_assets_plugin-0.0.6.tar.gz.

File metadata

File hashes

Hashes for mkdocs_github_release_assets_plugin-0.0.6.tar.gz
Algorithm Hash digest
SHA256 bb9e7a1e4212dd866ea6efca9d8ffbbf8aaf3d5c6b738a22eb9710d9f80bc70f
MD5 c0fa9700ccef17a8d466029d3a4e234f
BLAKE2b-256 1c95fd21f384c73b8339e15b537b30932ec48cff28843b666d22141bda285bab

See more details on using hashes here.

File details

Details for the file mkdocs_github_release_assets_plugin-0.0.6-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_github_release_assets_plugin-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 d71800df69151c5384e55fc5666346e73ed29edde2e522278ba949ba29170e04
MD5 114c3ed6523e8adf4551d99918f32d07
BLAKE2b-256 3aaf11da21929bed9faa42f1bdb23293ae16d06b5d75a00acf38fd8b3a674484

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page