On 2020-01-18 12:03, Mark Rotteveel wrote:
On 17-01-2020 15:00, Alex Peshkoff via Firebird-devel wrote:
On 2020-01-17 16:29, Mark Rotteveel wrote:
Hardly any of the documentation in the docs-folder have links, and
you can have links in Markdown.
No named paragraphs. I have no idea how to create a link to specific
paragraph in MD.
The GitHub-flavoured markdown uses
[<descriptive name>](#<section-name>), where <section-name> is the
lowercase form of the section title, with the spaces replaced by a
minus (-). It looks like that is the standardized form (though I'm not
100% sure of that).
Pandoc also supports: [<section title>], which I currently use with
Jaybird, but that isn't supported by GitHub.
With Markdown Viewer Webext for firefox
(https://github.com/KeithLRobertson/markdown-viewer) I've got for:
[ABC](#SQL Samples:)
[SQL Samples:]
the following result:
[ABC](#SQL Samples:) [SQL Samples:]
(Yes, I have a section 'SQL Samples' in that document).
I.e. suggested appears to be non-standard extensions and IMO bad style
for us.
Compare
https://raw.githubusercontent.com/FirebirdSQL/jaybird/master/src/documentation/release_notes.md
with
https://raw.githubusercontent.com/FirebirdSQL/jaybird/Branch_2_1/src/etc/release_notes.html
I've agreed that MD is much better for reviewing compared with
tool-written html. If we want to optimize our docs for good reviewing
let's go in this direction. In other aspects HTML appears better.
Firebird-Devel mailing list, web interface at
https://lists.sourceforge.net/lists/listinfo/firebird-devel
