struct Books::BookConfig

• Books::BookConfig
• Struct
• Value
• Object

Overview

Configuration from book.toml (mdbook compatibility)

Supported sections from mdbook spec:

• [book]: title, description, authors, language
• [output.html]: git-repository-url, edit-url-template (shown in sidebar/footer)

Not supported (noted for future reference):

• build: extra-watch-dirs, build-dir
• [output.html.*]: mdbook-specific output settings (except the above)
• [output.html.playground]: Rust playground integration
• [output.html.search]: Search config (we have our own search feature)
• [preprocessor.*]: mdbook preprocessor system

Defined in:

books.cr

Constructors

• .new(title : String | Nil = nil, authors : Array(String) | Nil = nil, description : String | Nil = nil, language : String | Nil = nil, create_missing : Bool = false, git_repository_url : String | Nil = nil, edit_url_template : String | Nil = nil)

Class Method Summary

• .from_file(book_toml_path : String) : BookConfig | Nil

  ameba:disable Metrics/CyclomaticComplexity

Instance Method Summary

• #authors : Array(String) | Nil
• #authors=(authors : Array(String) | Nil)
• #create_missing : Bool

  ameba:disable Naming/QueryBoolMethods

• #create_missing=(create_missing : Bool)

  ameba:disable Naming/QueryBoolMethods

• #description : String | Nil
• #description=(description : String | Nil)
• #edit_url_template : String | Nil
• #edit_url_template=(edit_url_template : String | Nil)
• #git_repository_url : String | Nil
• #git_repository_url=(git_repository_url : String | Nil)
• #language : String | Nil
• #language=(language : String | Nil)
• #title : String | Nil
• #title=(title : String | Nil)

Constructor Detail

Class Method Detail

Instance Method Detail