0

I searched, couldn't quite find anything similar, but apologies if asked and answered before.

Looking for a tool (in whatever form, standalone program, script, cli executable, something to go in the build process, whatever) to generate (easily digestible for a non-technical user) documentation, that you might find to describe an API, schema or class, such as apidocjs, xsddoc or javadoc, but for HTML.

The situation is as follows. I have HTML 'modules' built from several complex elements where various classes on various root and child elements affect the resultant display of the module. Just a typical use of HTML really, but the challenge is to document the effort and expose the different variations available to the client. Ultimately I'd like to display a toolkit of available elements that they could build pages of content from.

This is an interim solution between creating an interface to automatically generate the variations and present complete code to them, but wondering if there is something already available that can create documentation like this as a reference.

For obvious reasons, XML schema documenting fits the bill most closely I'd say, but the XML documentation tools, i.e. creating an xsd and using xslt to display, seems quite laborious to work with.

Any suggestions would be appreciated!

Update: standalone programs in windows or linux, only looking for free software. Found devbridge styleguide which looks perfect, but seems like they gave up on development a couple years ago and despite getting it to install, setup and run, it's pretty broken from there on.

  • 1
    What OS should it run on? What is your price limit if it comes to paid solutions? – Izzy Aug 3 '18 at 11:28
  • updated question... also, found github.com/davidhund/styleguide-generators which looks like it's got most of what I am looking at covered. – osbert Aug 3 '18 at 12:16

Your Answer

By clicking "Post Your Answer", you acknowledge that you have read our updated terms of service, privacy policy and cookie policy, and that your continued use of the website is subject to these policies.

Browse other questions tagged or ask your own question.