cynthia_websites_mini_client/configtype

Types

pub type CompleteData {
  CompleteData(
    global_theme: String,
    global_theme_dark: String,
    global_colour: String,
    global_site_name: String,
    global_site_description: String,
    server_port: option.Option(Int),
    server_host: option.Option(String),
    comment_repo: option.Option(String),
    git_integration: Bool,
    crawlable_context: Bool,
    sitemap: option.Option(String),
    other_vars: List(#(String, List(String))),
    content: List(contenttypes.Content),
  )
}

Constructors

  • CompleteData(
      global_theme: String,
      global_theme_dark: String,
      global_colour: String,
      global_site_name: String,
      global_site_description: String,
      server_port: option.Option(Int),
      server_host: option.Option(String),
      comment_repo: option.Option(String),
      git_integration: Bool,
      crawlable_context: Bool,
      sitemap: option.Option(String),
      other_vars: List(#(String, List(String))),
      content: List(contenttypes.Content),
    )
pub type SharedCynthiaConfigGlobalOnly {
  SharedCynthiaConfigGlobalOnly(
    global_theme: String,
    global_theme_dark: String,
    global_colour: String,
    global_site_name: String,
    global_site_description: String,
    server_port: option.Option(Int),
    server_host: option.Option(String),
    comment_repo: option.Option(String),
    git_integration: Bool,
    crawlable_context: Bool,
    sitemap: option.Option(String),
    other_vars: List(#(String, List(String))),
  )
}

Constructors

  • SharedCynthiaConfigGlobalOnly(
      global_theme: String,
      global_theme_dark: String,
      global_colour: String,
      global_site_name: String,
      global_site_description: String,
      server_port: option.Option(Int),
      server_host: option.Option(String),
      comment_repo: option.Option(String),
      git_integration: Bool,
      crawlable_context: Bool,
      sitemap: option.Option(String),
      other_vars: List(#(String, List(String))),
    )

    Arguments

    git_integration

    [True] Wether or not to enable git integration for the site.

    crawlable_context

    [False] Wether or not to insert json-ld+context into the HTML to make the site crawlable by search engines or readable by LLMs.

    sitemap

    [True] Wether or not to create a sitemap.xml file for the site. This is useful for search engines to index the site. This is separate from the crawlable_context setting, as no content needs to be rendered or served for the sitemap.xml file.

Values

pub fn complete_data_decoder() -> decode.Decoder(CompleteData)
pub const default_shared_cynthia_config_global_only: SharedCynthiaConfigGlobalOnly
pub fn encode_complete_data_for_client(
  complete_data: CompleteData,
) -> json.Json
pub const ootb_index: String
Search Document