Is here common source format to produce mdoc and MarkDown?
Mateusz Piotrowski
0mp at FreeBSD.org
Sun Feb 7 12:29:30 UTC 2021
On 05/02/2021 23:55, Brooks Davis wrote:
> On Sat, Feb 06, 2021 at 01:42:26AM +0300, Lev Serebryakov wrote:
>> I understand, that my question is not about FreeBSD documentation exactly, but close enough. If I'm not right, sorry.
>>
>> I want to have both proper man page in mdoc format and fancy README in MarkDown for github & ko for my project. Content of these documents must be virtually the same and I don't want to edit same text twice in different formats each time when I want to change it.
>>
>> Is here any source format to render both MarkDown and mdoc?
>>
>> I understand, that mdoc is semantic format (it has "options" and "arguments" and such), and MarkDown is not...
>>
>> Maybe, mdoc to MarkDown converter? It is not best way, as mdoc is very tedious to edit, but better than nothing.
> See mandoc(1) and -T markdown. No idea if it's any good.
It is pretty good.
There is also Pandoc, which as far as I remember allows you to convert Markdown documents into
manual pages.
Good luck,
Mateusz
More information about the freebsd-doc
mailing list