---
url: /reference/@cssdoc/markdown/interfaces/RenderIndexOptions.md
---
# Interface: RenderIndexOptions

Defined in: [emitters/markdown/src/render.ts:156](https://github.com/thedannywahl/cssdoc/blob/main/emitters/markdown/src/render.ts#L156)

Options controlling how the index renders.

## Extended by

* [`BuildCssApiOptions`](BuildCssApiOptions.md)

## Properties

### baseHref?

```ts
optional baseHref?: string;
```

Defined in: [emitters/markdown/src/render.ts:162](https://github.com/thedannywahl/cssdoc/blob/main/emitters/markdown/src/render.ts#L162)

Link prefix for page links (defaults to `"/"`; e.g. `"/api/css/"`).

***

### groups?

```ts
optional groups?: readonly string[];
```

Defined in: [emitters/markdown/src/render.ts:168](https://github.com/thedannywahl/cssdoc/blob/main/emitters/markdown/src/render.ts#L168)

Explicit group order for the sidebar and index. Listed labels come first, in this order; any
unlisted group follows in the default order ([KIND\_GROUPS](../variables/KIND_GROUPS.md) kinds, then custom `@group` groups
in first-appearance order). Omitted → the default order. See [groupEntries](../functions/groupEntries.md).

***

### intro?

```ts
optional intro?: string;
```

Defined in: [emitters/markdown/src/render.ts:160](https://github.com/thedannywahl/cssdoc/blob/main/emitters/markdown/src/render.ts#L160)

An intro paragraph under the H1.

***

### title?

```ts
optional title?: string;
```

Defined in: [emitters/markdown/src/render.ts:158](https://github.com/thedannywahl/cssdoc/blob/main/emitters/markdown/src/render.ts#L158)

The index H1 (defaults to `"CSS API reference"`).