struct

Books::BookConfig

Inherits Struct < Value < Object

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

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)
Source

Class methods

from_file(book_toml_path : String) : BookConfig | Nil

ameba:disable Metrics/CyclomaticComplexity

Source

Instance methods

authors
Source
authors=(authors : Array(String) | Nil)
Source
create_missing

ameba:disable Naming/QueryBoolMethods

Source
create_missing=(create_missing : Bool)

ameba:disable Naming/QueryBoolMethods

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