[Lazarus] FPDoc now with Markdown support

Michael Van Canneyt michael at freepascal.org
Thu Jan 7 12:24:48 CET 2021



On Thu, 7 Jan 2021, Santiago A. via lazarus wrote:

> El 05/01/2021 a las 10:47, Michael Van Canneyt via lazarus escribió:
>>
>> Because people are naturally lazy and prefer easy & simple over strict 
>> & rich.
>>
>
> But we could chose a language that is easy & simple for when you want to 
> do simple things (90% time) and rich when you need to do complex things.
> Asciidoc is very easy, but more standarized, and very rich if you need 
> to to do complex things.
>
> if markdown is to be used, it should be specified which flavor, not just 
> "markdown"
> https://github.com/commonmark/commonmark-spec/wiki/Markdown-Flavors
>
> if we are going for markdown (wouldn't be my first choice) I would go 
> for Github flavor
> https://docs.github.com/en/free-pro-team@latest/github/writing-on-github
>
> Once again, I would prefer Asciidoc

Anyone is free to propose an FPDoc importer for AsciiDoc, MarkDown (insert flavour of the
month), ReStructuredText.

All it needs to do is convert the given format to fpdoc format, which will
then be processed by fpdoc in the usual manner.

As I said, I do not plan to switch the existing documentation format to markdown 
or any other format. The idea is simply to make writing documentation easier for
other users.

I mentioned Markdown because I need it myself for work, so if I decide to work on it,
it will be markdown. In the original "Gruber" format, since that is what mkdocs uses,
and from first glances the used Python parser is very simple, straightforward and
extensible. The best I've seen yet.

Michael.


More information about the lazarus mailing list