class Books::Book

• Books::Book
• Reference
• Object

Overview

Book class representing a complete documentation book

Defined in:

books.cr

Constructors

• .new(name : String, title : String, chapters : Array(Books::ChapterEntry), description : Nil | String = nil, config : BookConfig | Nil = nil)

Instance Method Summary

• #chapters : Array(ChapterEntry)
• #chapters=(chapters : Array(ChapterEntry))
• #config : BookConfig | Nil
• #config=(config : BookConfig | Nil)
• #description : String | Nil
• #description=(description : String | Nil)
• #name : String
• #name=(name : String)
• #title : String
• #title=(title : String)
• #to_context : Hash(String, String | Nil)

  Convert to hash for template rendering

Constructor Detail

Instance Method Detail