search

dthree / wat

Instant, central, community-built docs
MIT License
495 stars 25 forks source link

verb templates #30

Closed tomByrer closed 9 years ago

tomByrer commented 9 years ago

More of an introduction & self-note to use verb's doc templating system as a way to semi-automatically make wat docs.

dthree commented 9 years ago

Nice - looks cool.

If have to look at it a bit more, but I can't tell if verb specializes in generating docs, or parsing existing docs. All wat is trying to do is parse existing documentation on the fly. I've got markdown pretty well taped, but I'm looking for someone / something to parse other types of docs, priority being a godoc document generator.

Wat also expects an exact format to parse the docs into - you can look at the docs/js section to see what it's sort of expecting.

tomByrer commented 9 years ago

It is just a templating system, helpful to save typing. example template. Written by the same guy who helped out with Assemble static site generator.

tomByrer commented 9 years ago

My main driver is a hope to have 1 source document system that is multi-target: README.md, HTML docs, wat, & devdocs.io/.

dthree commented 9 years ago

Ah - that would be great to have!

I don't think this is for Wat - but have no worries - the goal with Wat is to have it be compatible with all other things naturally, so everything is automatically Wat compatible.

So far, any docs with API in a readme is wat compatible. Next, I want to make an HTML parser, and that will open up a whole other set of docs. After that, a GoDoc parser.

dthree commented 9 years ago

Gonna close this for now, but feel free to discuss ideas with me on this :)