I wanted to create some documentation to drive a project. More precisely, I wanted to document a REST web service API, so that I could then build implementations of the API for multiple platforms.
I really like Stripe's API documentation—it's clean, well organized, responsive, and supports presenting code samples for multiple platforms.
I spent a little bit of time looking for a framework to speed development of my document, and I couldn't find anything that was both beautiful and simple to use. I didn't need a generator, I just wanted something pretty and approachable.
So I made this: api-docs.
Fork this repo.
Open index.html in your favorite editor.
Write your documentation.
Publish it as a GitHub page...? #winning
Section to be written.
MIT, all the way. Enjoy.
Copyright (c) 2016 James Davey
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.