namuol / cod

unassuming documentation format for any language

Home Page:http://namuol.github.io/cod

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Is this still active?

bar9 opened this issue · comments

Hi there

Would be interested in maintaining this and using it as a basis for a language-agnostic docgen tool.

What's your status?

Thanks for your interest - unfortunately I am no longer actively maintaining the project, but as far as I know it was never used outside my own personal projects. It never really left the "experimental" phase. Please give it a try and let me know if you have any success getting it working! It might be worth porting over to standard JS at least.

commented

Heya! Cod seemed like the perfect documentation tool for a project I'm currently working on, so I took it upon myself to rewrite it over the weekend since I couldn't get it to run under modern Node versions.

My fork is at https://github.com/jaames/cod

I just focused on my requirements, as such it's missing a few features like streaming support and some of the advanced tag stuff, but I've rewritten it in Typescript and removed the peg.js based parser to hopefully make it a little easier for other people to contribute if they want!

@jaames That's awesome! Thank you for your interest and for sharing your work here.

Some notes:

  • I updated the readme to mention that this project is not actively maintained.
  • I linked to @jaames' rewrite as a possible alternative for anyone who stumbles upon the project.

I'm this issue since I've formally updated the readme to answer this question. Thanks again for your interest!

commented

Oh sweet, thanks @namuol!

Would you mind if I also rehosted the documentation site with some edits? I want to make sure I'm not stepping on any toes. :)

Would you mind if I also rehosted the documentation site with some edits? I want to make sure I'm not stepping on any toes. :)

Oh sure, do whatever you want! Step away!