Learn what Docs is all about and how you can use it.
Docs is a simple HTML and CSS template for documentation of a project. It is made to provide documentation for smaller projects that don't need a whole user guide. An ideal use of Docs would be for a project with 5-6 basic sections that need to be covered. There is no limit to how many pages you can create. However, anything excessive would make better use of a full feature documentation tool.
There's only a few main steps to take to get your rotator up and running.
Copy and rename the
_template folder in your project:
_templatefolder from the root of the repo
docsor whatever you'd like
Replace the following variables in the
Since you already have full control over the HTML you generate, we provide some basic themes for you to start with. You can either take out themes and modify them or create a new one from scratch.
This documentation is powered by Docs so there really isn't much more to show. You can see our different Themes or take the time to view the source of these docs or the
_template folder if you'd like.
Design Docs to fit your project
We plan to provide a documentation outline for best practices when coding your docs and when styling your docs. At the moment, we only have our current docs. So duplicate that and modify for now.
If you have created a theme that you would like to contribute to Docs, please fork the project on github and submit a pull request for us to add it in. We thank you for any contributions!
Who is using docs already?
Docs is a fairly fresh project which was only created to satisfy a personal itch. We have decided to share it with the world because the world needs documentation. Since we use it, most of the sites listed here are our own. If you have a site you would like added to the list, please fork the repo and submit a pull request.
eh. not so much.
Unfortunately, we do not offer any support at the moment. Docs is made as a base template, so turn it into what you want!
What you can and can't do with this project.
We have released Docs under the MIT License which is stated as:
Copyright © 2011 by cmfolio 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.