Project

cosensee

0.0
The project is in a healthy, maintained state
Cosense (Scrapbox) parser and renderer
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Runtime

>= 0
>= 0
 Project Readme

Cosensee

Cosensee is a tool that reads JSON data from Cosense (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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/takahashim/cosensee.