Book class
Constructors
- Book({required String bookPath, required String langPath, required BookIgnore ignore, required BookConfig config, required BookReadme readme, required BookSummary summary, required BookGlossary glossary, String? lang})
- Book.empty(String lang)
-
factory
Properties
-
assets
→ List<
String> -
assets in a book
final
- bookPath → String
-
root directory of book
final
- config → BookConfig
-
Structure files
final
- glossary → BookGlossary
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- ignore → BookIgnore
-
final
- lang → String?
-
language from config, e.g. book.json
final
- langPath → String
-
path of lingual book
final
- language → String
-
language intent to show in html
no setter
- lingual → bool
-
Return true if book is one of multilingual books
no setter
-
pages
→ Map<
String, BookPage> -
pages in a book
final
- readme → BookReadme
-
final
- root → String
-
project root directory of whole book
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- summary → BookSummary
-
final
Methods
-
fileFsPath(
String path) → String -
filePath(
String path) → String - path relative to project root
-
isAsset(
String filename) → bool -
isContentFileIgnored(
String filename) → bool -
isIgnoredFile(
String filename) → bool -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
outputName(
String filename) → String -
pageJson(
BookPage page, {bool withContent = true}) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited