14

So I was writing docs for my project the hard way. Manually. Every time I added something new, I had to find the right place for it to be alphabetically in the reference. And god forbid I want to have the same information in two pages: I would need to copy/ paste and pray that I not forget to update the information EVERYWHERE.

I didn't feel like installing and learning some new markdown generating bullshit so I just made my own system. It's very simple and intuitive and I love it.

I made sure it can cover two use case: reading partial documents from the disk, and rendering in-memory objects to markdown too (like rendering a collection of tuples into a table)

I didn't care much for templating, so there's no templating capability.

Comments
  • 0
    But of course since it supports abstract rendering you could simply implement templating. All you need to do is give the Document object something with a render method. You could totally just make a TemplatedDocument class.
  • 0
    @AlgoRythm

    Holy shit you’re still kickin around! Damn son!

    Also, good work 😄
Add Comment