[ANN] lein-html5-docs 2.0.0

[Tassilo Horn]

Hi all,

I've just released version 2.0.0 of the lein-html5-docs plugin. Since
version 1.2.3, I've slightly refactored some parts of the code (but it's
still messy), and I have added one new killer feature: *SEARCH*! Yay!

That's how docs generated with the plugin look like:

http://userpages.uni-koblenz.de/~horn/funnyqt-docs/

Be sure to type something into the API Search box!

Bye,
Tassilo

[John Gabriele]

On Thursday, April 18, 2013 6:19:26 PM UTC-4, Tassilo Horn wrote:

That's how docs generated with the plugin look like:

  http://userpages.uni-koblenz.de/~horn/funnyqt-docs/

Nice, Tassilo!

Incidentally, it looks like most of the doc strings there are pretty-much markdown-formatted. I think the final output would look better if you assumed the docstrings themselves were markdown-formatted and rendered them as html. (That is, only have the items under "Arglists" in a preformatted block --- everything else would be html.)

---John

[Tassilo Horn]

John Gabriele <jmg...@gmail.com> writes:

Hi John,

>> That's how docs generated with the plugin look like:
>>
>> http://userpages.uni-koblenz.de/~horn/funnyqt-docs/
>>
>>
> Nice, Tassilo!

Thanks. :-)

> Incidentally, it looks like most of the doc strings there are
> pretty-much markdown-formatted.

Well, at least I enclose var and parameter names in `...` in my
docstrings.

> I think the final output would look better if you assumed the
> docstrings themselves were markdown-formatted and rendered them as
> html. (That is, only have the items under "Arglists" in a preformatted
> block --- everything else would be html.)

Hm, that sounds like a good idea. Is there some clojure lib that takes
a markdown-formatted string and returns plain HTML5 code?

Hey, and of course, pull requests are welcome.

Bye,
Tassilo

[John Gabriele]

On Friday, April 19, 2013 3:16:58 AM UTC-4, Tassilo Horn wrote:

> I think the final output would look better if you assumed the
> docstrings themselves were markdown-formatted and rendered them as
> html. (That is, only have the items under "Arglists" in a preformatted
> block --- everything else would be html.)

Hm, that sounds like a good idea.  Is there some clojure lib that takes
a markdown-formatted string and returns plain HTML5 code?

Well, there's <https://github.com/yogthos/markdown-clj>, which I think is actively maintained, though I've not used it.

I think it would be great if I could tell lein-html5-docs: "treat docstrings as markdown, render them as html, and shell out to Pandoc [^1] to do it".

[^1]: Pandoc supports some niceties I've gotten pretty used to, like tables, definition lists, deeply-nested lists, and LaTeX math.

---John

[Tassilo Horn]

John Gabriele <jmg...@gmail.com> writes:

Hi John,

Thanks, I've created an issue for that:

https://github.com/tsdh/lein-html5-docs/issues/1

But don't hold you breath. ;-)

Bye,
Tassilo