Add xqdoc to README.md for quick reference

[joewiz]

Something like https://github.com/jpcs/data.xq would be great.

[joewiz]

@lcahlander Does your xqdoc app produce markdown as an output format, by chance?

[joewiz]

I tried the xquerydoc tool used by jpcs's aforementioned data.xq project, and it choked on the XQuery 3.1 in semver.xqm. So I'm looking for an alternative that will read in the xqdoc comments in this module and generate documentation in markdown.

[lcahlander]

Hello Joe, It will parse markdown. I have included react-markdown into the app. I just have to take the time and actually implement the viewer. Loren

…

On Oct 25, 2021, at 10:56 AM, Joe Wicentowski ***@***.***> wrote: @lcahlander <https://github.com/lcahlander> Does your xqdoc app produce markdown as an output format, by chance? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#2 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAN4RONNPSYEMOFJ26FJUTDUIVVZZANCNFSM4IL6GFXQ>.

[joewiz]

@lcahlander Can I run an XQuery library module like this one through your xqdoc library to generate markdown? I'd love to paste markdown into the README for this and other repositories, to have a quick reference about what functions are available and what they do.

[lcahlander]

@joewiz I sent you the following file in slack that I use to generate DocBook from the xqDoc files. You can use them as a template. I then would use pandoc to convert the DocBook to MarkDown.
Archive.zip