YDoc

Installation

Add this line to your application's Gemfile:

gem 'ydoc'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ydoc

Usage

This gem provides the infrastructure to create, manage and send protocols, which are based on yaml files. Protocols often follow the same scheme and require the same information. Hence we can use a templates based approach. In the yaml file you declare basic information for a meeting. The yaml file can then be converted to html using pandoc as middleware. So make sure pandoc is installed. Also you can send the protocol by email.

Create

ydoc create

Generates a yaml template. You can provide additional information to fill the yaml file.

Build

ydoc build %file_or_directory

Creates a html file based on yaml files. First argument is either a yaml file or a directory containing yaml files. You can provide a config file serving additional information, which are used during pandoc conversion

{
  "html": {
    "toc": true,
    "tocDepth": 1,
    "selfContained": true,
    "standAlone": true,
    "numbered": true,
    "version": "1.0.0"
  }
}

Send

ydoc send %file

Sends an email to the present people of the meeting containing the html report as attachment. You have to provide a config file serving smtp information to send the email with. Here is an example file

{
  "email": {
    "address": "[email protected]",
    "port": 587,
    "host": "smtp.gmail.com",
    "username": "[email protected]",
    "password": "senderpassword"
  }
}

Help

ydoc help

Development

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.

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ydoc. 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.

License

The gem is available as open source under the terms of the MIT License.