Re: MarkDown conversion of specification live on SPDX GitHub


Matija Šuklje
 

Die 03. 07. 17 et hora 20.53.18 Steenbergen, Thomas scripsit:
Wanted to let you all know that after several months in the making I pushed
my MarkDown conversion of the SPDX specification 2.1 to
https://github.com/spdx/spdx-spec/
Brilliant! Thank you.

Limitations

· Simplified lay-out as MarkDown has some limitations compared to
Google Docs. See for example table of contents – no section included due
not being able to directly link to sections within different chapters
ToC with sections or subchapters of whatever depth should be doable and not
an issue with MarkDown itself, but with whatever software generates the
HTML/PDF/ePub/… from MarkDown.

There seems to be several ToC plugins for GitBook:
https://plugins.gitbook.com/browse?q=toc

e.g. this one:
https://plugins.gitbook.com/plugin/simple-page-toc
has a `maxDepth` option, with which you can select how deep it should go. The
default seems to be 3 levels (i.e. subsubsection).

For in-sentence references this would probably work:
https://stackoverflow.com/questions/5319754/cross-reference-named-anchor-in-markdown

Potentially useful for footnotes as well:
https://plugins.gitbook.com/plugin/footnote-string-to-number

· Introduce workaround for MarkDown shortcomings in HTML version
AFAIK simply using HTML tags is always a workaround in MarkDown.


cheers,
Matija
--
gsm: tel:+386.41.849.552
www: http://matija.suklje.name
xmpp: matija.suklje@...
sip: sip:matija_suklje@...

Join spdx@lists.spdx.org to automatically receive all group messages.