Config

type Config = object;

Defined in: types.ts:81

Configuration for the sidebar plugin

Since

1.0.0

Author

Simon Kovtyk

Properties

baseHref?

optional baseHref: string;

Defined in: types.ts:118

Base href for links

Since

1.0.0

Author

Simon Kovtyk

---

collapsible?

optional collapsible: Collapsible;

Defined in: types.ts:104

Collapsible groups configuration

Since

1.0.0

Author

Simon Kovtyk

---

cwd?

optional cwd: string;

Defined in: types.ts:97

Overrides the current working directory for resolving relative paths

Default Value

process.cwd()

See

https://nodejs.org/api/process.html#processcwd

Since

1.0.0

Author

Simon Kovtyk

---

index?

optional index: Index[];

Defined in: types.ts:111

Index configuration, to map sidebar items

Since

1.0.0

Author

Simon Kovtyk

---

normalizeDirNames?

optional normalizeDirNames: boolean;

Defined in: types.ts:141

Whether to normalize dir names by default

Default Value

false

Since

1.0.0

Author

Simon Kovtyk

---

normalizeDirNamesFn?

optional normalizeDirNamesFn: NormalizeTextFn;

Defined in: types.ts:148

Function to normalize dir names

Since

1.0.0

Author

Simon Kovtyk

---

normalizeLinkNames?

optional normalizeLinkNames: boolean;

Defined in: types.ts:126

Whether to normalize link names by default

Default Value

false

Since

1.0.0

Author

Simon Kovtyk

---

normalizeLinkNamesFn?

optional normalizeLinkNamesFn: NormalizeTextFn;

Defined in: types.ts:133

Function to normalize link names

Since

1.0.0

Author

Simon Kovtyk

---

path

path: string;

Defined in: types.ts:88

Path to the directory containing the markdown files

Since

1.0.0

Author

Simon Kovtyk

---

transformFn?

optional transformFn: TransformFn;

Defined in: types.ts:155

Function to transform sidebar items

Since

1.0.0

Author

Simon Kovtyk