Struct DocsConfig

Source

pub struct DocsConfig {Show 19 fields
    pub site: SiteConfig,
    pub base_path: String,
    pub content_dir: String,
    pub out_dir: String,
    pub public_dir: String,
    pub css: Option<String>,
    pub theme: Option<String>,
    pub components: Option<Vec<String>>,
    pub head: Vec<HeadTag>,
    pub nav: Vec<NavLink>,
    pub sidebar: Vec<SidebarSection>,
    pub sidebar_groups: BTreeMap<String, Vec<SidebarSection>>,
    pub custom_pages: HashMap<String, CustomPage>,
    pub regions: BTreeMap<String, RegionConfig>,
    pub state: Option<Value>,
    pub state_file: Option<String>,
    pub hero: Option<HeroConfig>,
    pub footer: Option<FooterConfig>,
    pub bundler: Option<BundlerConfig>,
}

Expand description

Documentation site configuration (read from config.json).

Fields§

§site: SiteConfig§base_path: String§content_dir: String§out_dir: String§public_dir: String§css: Option<String>§theme: Option<String>§components: Option<Vec<String>>§head: Vec<HeadTag>§nav: Vec<NavLink>§sidebar: Vec<SidebarSection>§sidebar_groups: BTreeMap<String, Vec<SidebarSection>>§custom_pages: HashMap<String, CustomPage>§regions: BTreeMap<String, RegionConfig>

Site-owned HTML fragments injected into named template regions before component discovery and protocol compilation.

§state: Option<Value>

Inline JSON object merged into every page’s render state. Mutually exclusive with stateFile.

§state_file: Option<String>

Path (relative to config.json) of a JSON object merged into every page’s render state. Mutually exclusive with state.

§hero: Option<HeroConfig>§footer: Option<FooterConfig>§bundler: Option<BundlerConfig>

Optional JavaScript bundler configuration (overrides defaults).

DocsConfig

Struct DocsConfig Copy item path

Fields§

Trait Implementations§

impl Debug for DocsConfig

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

impl<'de> Deserialize<'de> for DocsConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Auto Trait Implementations§

impl Freeze for DocsConfig

impl RefUnwindSafe for DocsConfig

impl Send for DocsConfig

impl Sync for DocsConfig

impl Unpin for DocsConfig

impl UnsafeUnpin for DocsConfig

impl UnwindSafe for DocsConfig

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

fn in_current_span(self) -> Instrumented<Self> ⓘ

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘwhere F: FnOnce(&Self) -> bool,

impl<T> Pointable for T

const ALIGN: usize

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> Same for T

type Output = T

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = !

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Struct DocsConfig

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,