KDoc provides a document in the form a DSL that contains flexible key/value and tabular data
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
gem install k_doc
As a Developer, I need flexible data structures defined in DSL, so can model rich documents
See all stories
See all usage examples
Description for a basic example to be featured in the main README.MD file
class SomeRuby; end
Checkout the repo
git clone klueless-io/k_doc
After checking out the repo, run
bin/setup to install dependencies. Then, run
rake spec to run the tests.
You can also run
bin/console for an interactive prompt that will allow you to experiment.
bin/console Aaa::Bbb::Program.execute() # => ""
k_doc is setup with Guard, run
guard, this will watch development file changes and run tests automatically, if successful, it will then run rubocop for style quality.
To release a new version, update the version number in
version.rb, build the gem and push the
.gem file to rubygems.org.
rake publish rake clean
Bug reports and pull requests are welcome on GitHub at https://github.com/klueless-io/k_doc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the K Doc project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
Copyright (c) David Cruwys. See MIT License for further details.