---
url: /reference/@cssdoc/markdown/functions/renderIndex.md
---
# Function: renderIndex()

```ts
function renderIndex(entries, options?): string;
```

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

Render the index/overview page: records grouped by `@group` (or their kind), each a table with its
summary. See [groupEntries](groupEntries.md) for the grouping and order.

## Parameters

### entries

readonly [`CssDocEntry`](../../core/interfaces/CssDocEntry.md)\[]

### options?

[`RenderIndexOptions`](../interfaces/RenderIndexOptions.md) = `{}`

## Returns

`string`