I’ve finally produced some documentation for base2. It is still incomplete but at least it’s a start. The base2 core is mostly documented now. The core is tiny (6KB gzipped) but includes enough juicy bits to allow me to build something more complex like base2.DOM.
Neither base2 nor base2.DOM are officially released yet but you can use the beta versions hosted here:
The two files above are also merged into a single file:
Note: -p(acked) version, -f(ull) version.
The documentation is written using MiniWeb. I did this for two reasons. First, I wanted an excuse to use MiniWeb for something. Second, I wanted to separate my documentation from my source code, I dislike paging through reams of comments when I’m debugging. The MiniWeb documentation system builds skeletal documentation based on the code it finds in the page. It includes an editor and a navigation system so that I can start browsing my APIs, documenting as I go.