Skip to content

tjbenton/docs

Repository files navigation

Docs

The next generation documentation engine for any language

Travis Status devDependencies status


Docs, adapts to any language and will help you document all the things.Where there is development there is a need for documentation. There are several great libraries for all sorts of files, written by brilliant developers, libraries like SassDoc, JSDoc, JavaDoc, Jazzy, StyleDocco, KSS, Hologram, DSS and several more. All of these libraries do a very good job for documenting their respective languages. However there are very few projects that suport more than 1 language. Which means if you really want to document all your code you may have to use 3 or 4 of these documentation generators. Each of the generators have their own way of documenting and their annotations, and their own document site which just makes it harder to keep all your documentation in one spot.

Docs fixes all these issues by giving you the ability to generate documentation for all your files. While giving you control over what annotations you want to use in each file type.

Want to report a bug or request a feature?

Bugs and feature requests can be posted at https://github.com/tjbenton/docs/issues.

Want to contribute to Docs?

Check out our CONTRIBUTING.md.

Packages

The Docs repo is managed as a monorepo; it's composed of many npm packages.

Credits