Struct ReadmeConfig 

pub struct ReadmeConfig {
    pub template_dir: Option<PathBuf>,
    pub snippets_dir: Option<PathBuf>,
    pub config: Option<PathBuf>,
    pub output_pattern: Option<String>,
    pub discord_url: Option<String>,
    pub banner_url: Option<String>,
    pub languages: HashMap<String, Value>,
    pub targets: HashMap<String, Value>,
}

Fields

template_dir: Option<PathBuf>

snippets_dir: Option<PathBuf>

config: Option<PathBuf>

Deprecated: path to an external YAML config file. Prefer inline fields below.

output_pattern: Option<String>

discord_url: Option<String>

Discord invite URL used in README templates.

banner_url: Option<String>

Banner image URL used in README templates.

languages: HashMap<String, Value>

Per-language README configuration, keyed by language code (e.g. “python”, “typescript”, “ruby”). Values are flexible JSON objects that map directly to minijinja template context variables.

targets: HashMap<String, Value>

Non-language README targets, keyed by target name (e.g. “root”, “cli”). Targets must declare output_path or output.

Trait Implementations

impl Clone for ReadmeConfig

fn clone(&self) -> ReadmeConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReadmeConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReadmeConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ReadmeConfig

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for ReadmeConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.