[TOC]

Markdown Docs

This repository contains the definition of a Docker image that can be used both as a builder stage and as an action.

Markdown docs is implemented as a jam of shell scripts, python scripts and python utilities like Python Markdown, with some additional plugins like Table of Contents, Tables and, on top of all, PlantUML Markdown. This extension enables the inclusion of PlantUML diagrams (UML, JSON...) rendered inline inside your website. It also supports the !include directive for PlantUML reuse of code.

Usage

As GitHub Action

As Docker builder

Documentation

Markdown

Entrypoint: index.md

Contents: contents.md

Custom CSS: css/style.css