On 17.01.2020 16:29, Mark Rotteveel wrote:
On 2020-01-17 11:32, Dimitry Sibiryakov wrote:
17.01.2020 08:14, Mark Rotteveel wrote:
That is the whole point of markdown: that it is a human-readable
plain text file that can be converted to better looking HTML or PDF
with a tool.
The main feature of HTML/PDF is not a "better look" but a fast
navigation between parts with hyperlinks which is important for manual
references.
Hardly any of the documentation in the docs-folder have links, and you
can have links in Markdown. And if having HTML is important, I'd
suggest to write the docs in markdown (or maybe asciidoc) and generate
HTML as part of the build (eg using pandoc). That is what most other
opensource projects do these days. For good reasons: authoring and
diffing is easier compared to HTML, more powerful in its output option
compared to 'just' plain text, and readable both in source form and in
rendered output.
Mark
Also online documentation with tool like https://readthedocs.org/ can be
generated. Current txt docs can be converted to markdown with small blood.
Firebird-Devel mailing list, web interface at
https://lists.sourceforge.net/lists/listinfo/firebird-devel
