dauxio / daux.io

Daux.io is an documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.
https://daux.io/
MIT License
796 stars 196 forks source link

Add content containers (markdown extension) #224

Closed aedart closed 1 year ago

aedart commented 4 years ago

It would be really nice being able to use "content containers", similar to those available in vuepress. Authors are then able to highlight specific content, and thereby increasing the chance that readers are made aware of specific information, e.g. warnings or tips.

I'm pretty sure that this isn't a part of any markdown standard. Yet I do not believe that it will decrease the readability of the source markdown file, provided that a similar easy syntax is used, as that from vuepress.

onigoetz commented 4 years ago

Hi, this is a very interesting feature, I'll have a look if such an extension exists. If not I'll try to figure out how to implement it.

Can't give a deadline though

Jako commented 3 years ago

It is part of the python markdown standard extensions: https://python-markdown.github.io/extensions/admonition/ and it would be great, if this could be included into daux too.

BTW: implementing footnotes would be nice too.

onigoetz commented 1 year ago

I just implemented this feature in the master branch.

Works for both HTML and Confluence rendering

I will add some tests and release it soon after

onigoetz commented 1 year ago

Released in 0.20.2 : https://github.com/dauxio/daux.io/releases/tag/0.20.2