https://github.com/yaodong/gem-ulysses

A Ruby gem to handle Ulysses library and print out HTML
https://github.com/yaodong/gem-ulysses

Last synced: 22 days ago
JSON representation

A Ruby gem to handle Ulysses library and print out HTML

• Host: GitHub
• URL: https://github.com/yaodong/gem-ulysses
• Owner: yaodong
• License: mit
• Created: 2016-02-06T04:12:02.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2019-03-05T19:28:18.000Z (almost 6 years ago)
• Last Synced: 2024-12-20T21:15:16.672Z (about 1 month ago)
• Language: Ruby
• Homepage: https://rubygems.org/gems/ulysses
• Size: 33.2 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Ulysses

[![Join the chat at https://gitter.im/yaodong/gem-ulysses](https://badges.gitter.im/yaodong/gem-ulysses.svg)](https://gitter.im/yaodong/gem-ulysses?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://travis-ci.org/yaodong/gem-ulysses.svg?branch=master)](https://travis-ci.org/yaodong/gem-ulysses)

This is a library to export your to HTML files. It still in development.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'ulysses'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install ulysses

## Usage

Get your library:

    library = Ulysses::Library.new

Get groups from library

    groups = library.groups

Get children groups:

    group = library.groups.first

    children = group.children

Get Sheets:

    group.sheets

Print sheet to HTML:

    printer = Ulysses::Printer.new(library) # also applies to group or sheet

    html = printer.print

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/yaodong/gem-ulysses. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).