Jadis (Just Another Documentation and Instruction Solution) is a simple documentation generation solution. Unlike the excellent tool, YARD, Jadis is for user-facing documentation or for developer documentation that is unconnected to any particular code or codebase.
Jadis provides tools for:
- Generating static HTML with Markdown.
- Enforcing a navigational structure.
- Creating and delivering searchable documentation.
Planned improvements include:
- Versioned documentation.
- Local, live-reloading server for testing.
Run this command to install Jadis:
$ gem install jadis
TODO: Write usage instructions here
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. Run bundle exec jadis to use the gem in this directory, ignoring other installed copies of this gem.
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, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/mattmeng/jadis.
The gem is available as open source under the terms of the MIT License.