class

Hwaro::Services::Scaffolds::Docs

Inherits Hwaro::Services::Scaffolds::Base / Reference / Object

Instance methods

archetype_files

Docs ships section-specific archetypes so hwaro new getting-started/foo.md, guide/foo.md, and reference/foo.md each auto-match (see Services::Creator#find_archetype) with docs-shaped front matter (weight/toc) that a generic default.md would miss.

Source

config_content(skip_taxonomies : Bool = false, multilingual_languages : Array(String) = [] of String) : String

Returns the config.toml content. multilingual_languages (from --include-multilingual) is threaded through so the full config emits a real, enabled [languages] block instead of the commented placeholder.

Source

content_files(skip_taxonomies : Bool = false) : Hash(String, String)

Returns sample content files as a hash of path => content

Source

description

Returns the description of this scaffold

Source

static_files

Returns static files as a hash of path => content. Every scaffold inherits a tiny SVG favicon so a freshly-generated site doesn't show a blank tab icon. Scaffolds that override static_files (blog/docs/book) merge super to keep it.

Source

template_files(skip_taxonomies : Bool = false) : Hash(String, String)

Docs templates share nav, search, and sidebar across page, section, taxonomy, and 404 — extracting those into partials/ makes "edit the nav" a one-file change and keeps 404/taxonomy inside the docs-container so footer.html's closing tags actually match what the body opens.

Source

type

Returns the scaffold type

Source