beautiful-docs

Pointers to useful, well-written, and otherwise beautiful documentation.

Beautiful Docs

I love documentation. If you work with/are writing code intended for usage and consumption by more than one person, you should love it, too. Documentation and other resources will make or break the success of your project. And the more open and collaborative you want development to be, the more crucial docs become.

With that in mind, here’s a list of docs and other developer resources that myself and others find particularly useful, well-written, and otherwise “beautiful”. May they serve to inspire you when writing and designing yours.

This should be updated fairly regularly. As usual, pull requests are encouraged.

Mark

And Now For The Docs (in no particular)

Related Repositories

beautiful-docs

beautiful-docs

Pointers to useful, well-written, and otherwise beautiful documentation. ...

Docbase

Docbase

Turn markdown docs into beautiful sites ...

MathJax-docs

MathJax-docs

MathJax documentation. Beautiful math in all browsers. Beautifully documented. ...

kristin

kristin

Convert PDF docs to beautiful HTML files without losing text or format. This gem uses pdf2htmlEX to do the conversion. ...

api2html

api2html

A CLI tool to transform Swagger/OpenAPI/AsyncAPI docs to beautiful HTML pages via Shins/Widdershins. ...


Top Contributors

mrtazz dougselph roidrage mrb seancribbs