Sha256: 4ee73c7415f984f3afde19c91d9c0115da70da3860171f3af7765906bc6fef4c

Contents?: true

Size: 1.41 KB

Versions: 1

Compression:

Stored size: 1.41 KB

Contents

# Cosensee

Cosensee is a tool that reads JSON data from [Cosense](https://scrapbox.io) (formerly Scrapbox) and outputs it in HTML format.

## Installation

Install the gem:

    $ gem install cosensee

If you use bundler, add to the application's Gemfile by executing:

    $ bundle add cosensee

## Usage

To output HTML, specify the JSON file from Cosense as an argument and run `bin/build` with Cosense JSON dump file.

    $ bin/build <json file>

The HTML files will be output to the .out directory. You can view them locally by using the bin/server command.

    $ $bin/server

By adding a Cosense JSON file as an argument, the build process will be executed before starting the server.

    $ $bin/server <json file>

The default port used by bin/server is 1212.

## 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 the created tag, 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/takahashim/cosensee.

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
cosensee-0.6.0 README.md