documentator has one primary goal: having better docs on our projects.
documentator provides two main features to achieve that goal:
With bundler, add it to your
group :development do gem "documentator" end
Commands should be used from the root directory of the current project.
bootstrap provides a minimal set of documentation files.
Those are empty, and they must be written for each project. The content is
specific to each project:
- What's the architecture? (providing a ditaa schema will earn you some extra karma points)
As a treat,
bootstrap generates a Gemfile in
project/doc which includes
Guide'em up. Guide'em up can be used to
preview markdown file in a browser.
bundle exec documentator bootstrap
import provides templates for common documentation that should be the same
from one project to another. Installing ElasticSearch is basically always the
same. If there are projet specific particularities, you can always add them
bundle exec documentator list
A language can be specified to the
bundle exec documentator list fr
A language must be specified to the
bundle exec documentator import fr beanstalkd mongodb
YES. We want contributions.
- Adding a bootstrap's file is done by adding a file to
- Adding a templates's file is done by adding a file to
MIT. See LICENSE for further details.