BlueDoc::Toc

BlueDoc Table of Contents parse library.

Installation

Add this line to your application's Gemfile:

gem 'bluedoc-toc'

And then execute:

$ bundle

Usage

@content = BlueDoc::Toc.parse(read_file("sample.yml"))
@content.each do |item|
  puts item.id
  puts item.title
  puts item.url
  puts item.depth
end

@content = BlueDoc::Toc.parse(read_file("sample.json"), format: :json)
@content.to_html
@content.to_markdown
@content.to_json
@content = BlueDoc::Toc.parse(read_file("sample.md"), format: :markdown)
@content.to_html(prefix: "https://bluedoc.io/bluedoc/docs/")

Contributing

Contribution directions go here.

License

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