A documentation template written in RAML and thor tasks to turn documentation into so much more.
Add this line to your application's Gemfile:
gem 'textualize'Textualize comes with the following generators:
textualize new <folder-name>The textualize new command creates sample documentation with the folder
structure needed for the other commands.
textualize serverThe textualize server command creates a folder structure of JSON in the
dist/server folder.
textualize http_backendThe textualize http_backend command creates a minified javascript file,
dist/angular/backend/fake_http_backend.min.js that contains an angular module that
can be injected to provide a stubbed
httpBackend.
This can be used in both e2e tests and for prototyping.
textualize request_specsThe textualize request_specs command creates a folder of request specs
written in airborne at
dist/spec/request_specs that can be used writing ruby apps with Rack.
It is recommended that tests are run in isolation while developing, and
as a suite in continuous integration.
After checking out the repo, run bin/setup to install dependencies. Then, run
bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To
release a new version, update the version number in version.rb, and then run
bundle exec rake release to create a git tag for the version, push git
commits and tags, and push the .gem file to
rubygems.org.
- Fork it ( https://github.com/[my-github-username]/textualize/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request