hexdocs_offline/config

This module holds the main Config record type. It is used to identify the parameters of which gleam.toml file to use and where to put the resulting html files.

Types

Config

</>

pub type Config {
  Config(
    manifest_path: String,
    gleam_path: String,
    output_path: String,
    include_dev: Bool,
    new_tab: Bool,
    ignore_deps: List(String),
    hex_home: String,
  )
}

Constructors

Config(
  manifest_path: String,
  gleam_path: String,
  output_path: String,
  include_dev: Bool,
  new_tab: Bool,
  ignore_deps: List(String),
  hex_home: String,
)

Functions

default_config

</>

pub fn default_config() -> Config

default_gleam_path

</>

pub fn default_gleam_path() -> String

default_hex_home

</>

pub fn default_hex_home() -> String

read more here: https://hexdocs.pm/hex/Mix.Tasks.Hex.Config.html

default_manifest_path

</>

pub fn default_manifest_path() -> String

default_output_path

</>

pub fn default_output_path() -> String

with_file_path

</>

pub fn with_file_path(
  config: Config,
  manifest_path: String,
) -> Config

with_gleam_path

</>

pub fn with_gleam_path(
  config: Config,
  gleam_path: String,
) -> Config

with_hex_home

</>

pub fn with_hex_home(config: Config, hex_home: String) -> Config

with_ignore_deps

</>

pub fn with_ignore_deps(
  config: Config,
  ignore_deps: List(String),
) -> Config

with_include_dev

</>

pub fn with_include_dev(
  config: Config,
  include_dev: Bool,
) -> Config

with_new_tab

</>

pub fn with_new_tab(config: Config, new_tab: Bool) -> Config

with_output_path

</>

pub fn with_output_path(
  config: Config,
  output_path: String,
) -> Config