ldeluigi/markdown-docs

Action/docker image that transforms your markdown into a static website. No need for particular configuration: it just works.

markdown-docs's Issues

Fix tables included with markdown-include

Blocked by cmacmackin/markdown-include#42

Custom colors

Add the possibility to customize colors and maybe logos

callout boxes are not rendered in html

Github flavored markdown support callout boxes such as:

> [!WARNING]
> Text goes here.

Warning

Text goes here.

> [!IMPORTANT]
> Text goes here.

Important

Text goes here.

> [!WARNING]
> Text goes here.

Warning

Text goes here.

These callouts are currently not rendered in the html output:

I'd appreciate it if this could be supported.

Write README

JSON support

Currently missing from plugin
Can't do much

Mobile CSS not working

Hide GitHub links from private repositories

Add MIT License

I kindly suggest adding an MIT license in order to allow other people to use the action with the formal right permission.

TOC CSS is not optimized

It takes too much space at the top of the file... also its behaviour is inconsistent

Implement Print mode CSS with media query

In order to provide printable documentation from the browser

Index file

Without an index navigation is not the best: generate one to fix this

Favicon is not configurable

Setting the icon parameter in the action does not change the favicon in the generated website.

Add back support for jupyter notebooks

Blocked by danielfrg/mkdocs-jupyter#117

CSS stylesheet link broken

It doesn't work for nested files

Math mode + syntax

Is it good? Is it available? Or else add it

PlantUML default theme is ugly

Table CSS missing

Missing CSS

404 page is broken

Global scoped TOC issue

The HTML is not well generated

Global TOC CSS should be fixed

The nav seems smaller

.py files are treated as Notebooks

index.html has duplicate links

Remove warning from git-authors-plugin

Blocked by timvink/mkdocs-git-authors-plugin#70

plantuml.sh not necessary anymore with new plantuml-markdown options

Linking JS files in HTML meta

Support repo URL + edit mode