Export in Markdown

Please post all questions relating to using Help+Manual version 10 here.

Moderators: Alexander Halser, Tim Green

Post Reply
Tansy
Posts: 96
Joined: Wed Aug 25, 2010 11:37 am

Export in Markdown

Unread post by Tansy »

Can this version export the entire project in Markdown?
User avatar
Tim Green
Site Admin
Posts: 7818
Joined: Mon Jun 24, 2002 9:11 am
Location: Bruehl, Germany
Contact:

Re: Export in Markdown

Unread post by Tim Green »

Tansy wrote: Mon Dec 08, 2025 1:17 pm Can this version export the entire project in Markdown?
Help+Manual supports Markdown import but it will never support Markdown export, because it would not make any sense. Markdown is extremely minimalist and does not cover even a tiny fraction of Help+Manual's formatting or export capabilities.
Regards,
Tim (EC Software Documentation & User Support)

Private support:
Please do not email or PM me with private support requests -- post to the forum directly.
michal_novomesky
Posts: 62
Joined: Thu Jan 12, 2012 2:21 pm
Contact:

Re: Export in Markdown

Unread post by michal_novomesky »

Two available options based on Tim's answer:

1
- Publish as HTML.
- Use any free "HTML to Markdown" converter.

2
- Write / vibe-code a H&M XML to .md converter by yourself.
User avatar
Tim Green
Site Admin
Posts: 7818
Joined: Mon Jun 24, 2002 9:11 am
Location: Bruehl, Germany
Contact:

Re: Export in Markdown

Unread post by Tim Green »

Update: We are actually reconsidering the question of Markdown export because there is now one very important genuine use case, which is providing data to AI systems. Markdown is currently the best format for inputting data into AI systems, so it would make sense to generate this from HM projects, despite the great loss of formatting and presentation features, which the AI systems don't need.

This being said, it's not a trivial undertaking. The data would have to be prepared, structured and tagged in a special way so that AI systems can "understand" it optimally, so it is definitely a long-term project. 8)
Regards,
Tim (EC Software Documentation & User Support)

Private support:
Please do not email or PM me with private support requests -- post to the forum directly.
Andy Micone
Posts: 6
Joined: Wed Mar 28, 2012 7:14 pm

Re: Export in Markdown

Unread post by Andy Micone »

It is no doubt hard because people are, as always, busy reinventing the wheel, and there's no standardized format at all.

IMHO, some support would be useful not only for the AI use case but also because some of us sometimes find ourselves publishing to CMS systems that expect markdown as the file format and don't allow HTML uploads. This would include flavors like reStructuredText, Sphinx/MyST, GitHub, GitBook, and MkDocs. Also, mentioning AI, there is the Jupyter notebook format. I even deal with obscure Markdown variants like Fountain sometimes.

It seems pretty counterintuitive to me, but rather than stand up a simple website to host HTML output, some organizations view it as a security concern and would rather you do everything in some flavor of markdown within their CMS or LMS that renders to HTML anyway. These are some of the same systems that provide content for their help bots, which they are currently very invested in.
User avatar
Tim Green
Site Admin
Posts: 7818
Joined: Mon Jun 24, 2002 9:11 am
Location: Bruehl, Germany
Contact:

Re: Export in Markdown

Unread post by Tim Green »

Andy Micone wrote: Thu Mar 12, 2026 11:38 pm It seems pretty counterintuitive to me, but rather than stand up a simple website to host HTML output, some organizations view it as a security concern and would rather you do everything in some flavor of markdown within their CMS or LMS that renders to HTML anyway. These are some of the same systems that provide content for their help bots, which they are currently very invested in.
Then it makes sense to work directly in a simple text editor that supports Markdown. :mrgreen:
Regards,
Tim (EC Software Documentation & User Support)

Private support:
Please do not email or PM me with private support requests -- post to the forum directly.
Post Reply