Welcome to little lamb

New releases of qmdoc and limb

Posted

A new release of qmdoc is out !

qmdoc is a simple, lightweight, fast tool that will convert MarkDown files into (JavaScript-free) HTML files, with an aim at documentation.

This new release 0.2.0 can now take directories as argument, processing every file named *.md it said directory and its subdirectories.

Additionally notion of groups and sorting groups have been added, to automatically sort pages by their titles or file names, as well as optionally creating groups in the pages' TOC.

A special handling of symlinks has also been added to allow one page to have multiple names linking to it.

All of this can notably be found useful when making documentation in form of man-pages. As an example of what it can lead to, don't hesitate to check out the Documentation section.

You can find out more about it here, with links to download it, read/clone its source code or read more in its documentation.

limb is out (again)

To go along with the new release of qmdoc we have a new release of lila's core library, limb. Technically, this isn't its first release, or even its second one, but you know what ? Let's pretend it is...

Yeah, limb has had releases before, because it was used for e.g. previous releases of qmdoc and as such needed to be out.

But.

Really, it was mostly 3 or 4 small functions, that's about it. Most of which have been refactored/renamed since, and at this point there is significantly more than just a couple of functions now.

It might be my laziness talking, but it feels like trying to come up with a list of changes would be a long and eventually useless task. So I did not.

Instead, I invite you to forget about previous releases of limb and think of this version 0.1.0 as a first release. Meaning, do not ask what is new about it - because everything is - and maybe just ask, what is it (about) ?

And to answer that, let me guide you to its online documentation (generated by, you guessed it, qmdoc!) since, yes, it is documented.

skalibs

Let me add a quick note about how limb is very much based on skalibs. Not only that, but quite a few functions available in limb are actually implemented in skalibs.

That is to say, as a rule when I use limb I use its own headers, nothing from skalibs itself. That's how it's intended to work, even though the truth is, some of limb's headers might be just an include of the corresponding header from skalibs.

But, the rule is also that anything that's "officially" in limb should be documented, which means that part of limb's documentation pretty much applies to skalibs. Which might be worth of interest even if you don't intend to use limb (but only skalibs).

Should be noted though, that limb's documentation might be for functions straight from skalibs and that, as such, fully apply to it. It might also be for what are actually macros because there's a slightly different interface (e.g. a change in the order of arguments), little wrapper around skalibs' functions, or just full limb functions. (And no, which it is isn't indicated.)

New site design

Oh yeah, and the site's got a brand new "design". Hopefully it's a bit of an improvement over the previous one.

Also comain...

And for the sake of being complete, I guess, let's mention how comain was also bumped a new version. It's still very much an internal piece of software, not that that's an excuse but it's also (sadly) completely undocumented.

Curious minds can read its source code if they feel so inclined, though. :-)