matheusfelipeog / beautiful-docs Goto Github PK

The following link is broken https://jacobian.org/writing/great-documentation/ and I cannot find the article anywhere.

Similar to flatdoc and slate, generates great documentation from markdown with clean URLs and great formatting. http://daux.io/

Add these

http://labs.codernity.com/codernitydb/design.html

I'm mostly looking for tools/libraries that help projects build documentation that showcases their javascript. Sites like http://github.hubspot.com/executr/ or http://requirebin.com/ come to mind as starters.

Are you still accepting PR's and maintaining this repo? If you're short on time I would be happy to help you.

https://github.com/apiaryio/api-blueprint

I personally suggest http-api-design It's nice documentation.

This list is very similar to https://github.com/sindresorhus/awesome. You should add this repo to the list so it gets more traction!

Add this:
http://jackschaedler.github.io/circles-sines-signals/

http://www.packer.io/docs - the latest hotness from @mitchellh

http://markdocs.org/ is now a parked page

http://developer.postmarkapp.com/

I was going to do a PR on docz and docusaurus, but it's clearly pointless.

Qt project incl. docs are in the process of moving to qt.io. The latest docs -- 5.3, you link to 4.8 -- are at http://qt-project.org/doc/qt-5/reference-overview.html but should soon be at qt.io.

@PharkMillups love this list! Enough that I made a PR to get it onto the official awesome list:

sindresorhus/awesome#313

To get on there, the page needs a few changes. I can make these changes for you, I just want to check with you first if you care. If not, I can just close that PR.

Happy documenting!

these are pretty damn sexy.

https://httpkit.com/resources/HTTP-from-the-Command-Line/

version: 1.0.0
source file:

# Users

## /users [GET] 

### Params:

    _token // session token (required)
    _withCompany // join companies (optional)
    _withRole // join roles (optional)

### Response:
    [{Id: ...}]

### Errors:

    ERROR_NO_CONTENT // empty array response
    ERROR_AUTHORIZATION_FAILURE // access control error
    ERROR_OK // success

## /users/{id} [GET]

### Params:
    _token // session token (required)
    _withCompany // join companies (optional)
    _withRole // join roles (optional)

### Response:
    {Id: ...}

### Errors:
    ERROR_NOT_FOUND // record is deleted
    ERROR_AUTHORIZATION_FAILURE // access control error
    ERROR_OK // success

output

Users

/users [GET]

Params:
_token // session token (required)
_withCompany // join companies (optional)
_withRole // join roles (optional)
Response:
[{Id: ...}]
Errors:
ERROR_NO_CONTENT // empty array response
ERROR_AUTHORIZATION_FAILURE // access control error
ERROR_OK // success
/users/{id} [GET]

Params:
_token // session token (required)
_withCompany // join companies (optional)
_withRole // join roles (optional)
Response:
[{Id: ...}]
Errors:
ERROR_NO_CONTENT // empty array response
ERROR_AUTHORIZATION_FAILURE // access control error
ERROR_OK // success
/users/{id} [GET]

Params:
_token // session token (required)
_withCompany // join companies (optional)
_withRole // join roles (optional)
Response:
{Id: ...}
Errors:
ERROR_NOT_FOUND // record is deleted
ERROR_AUTHORIZATION_FAILURE // access control error
ERROR_OK // success

http://emberjs.com/documentation/

https://github.com/CodyHouse/faq-template

This list is now pretty long and has grown in scope. Take a pass a refining the organization and categorization of resources.

http://learn.getgrav.org/

Cheers!

Figure out some way to add this

http://www.clojureatlas.com/

https://try.github.io/

Beautiful documentation about a color scheme, using the color scheme.

• http://ethanschoonover.com/solarized
• https://github.com/altercation/

http://sassdoc.com

Cheers. :)

Thanks for a great collection of docs. I have just discovered it and enjoyed it very much.

I would just like to point out that the Learn you Erlang book is actually inspired by the Learn you Haskell book. I think that book also deserves to be on the list. Reference.

Thanks

Some of the best server docs I've had the pleasure of reading.

http://www.cppsamples.com/

"Hologram is a Ruby gem that parses comments in your CSS and helps you turn them into a beautiful style guide."

https://github.com/trulia/hologram

extensive