---
title: "FAQ Plugin"
description: "FAQ management, with nested sections and a sidebar."
type: "docs"
category: "doc"
tags: []
authors: [Anonymous]
date: "2026-08-21"
last_update: "2026-08-21"
time_minutes: 2
draft: false
unlisted: false
url: "https://www.derafu.dev/docs/ui/content/faq"
---

# FAQ plugin

Manages frequently asked questions, nested arbitrarily deep — see [Content hierarchy](./introduction#content-content-hierarchy). Structurally very similar to [Docs](./docs), just under `/faq` instead of `/docs`.

## Configuration (`services.yaml`)

Enabled under `derafu.content.config.plugins.faq`:

```yaml
parameters:
    derafu.content.config:
        plugins:
            faq: ~
```

| Option | Type | Default | Description |
|---|---|---|---|
| `path` | string | `resources/content/faq` | Directory scanned for questions, relative to the website root. |
| `include` | array of glob patterns | `['**.{markdown,md}']` | Files considered content, relative to `path`. |
| `exclude` | array of glob patterns | `[]` | Files excluded even if matched by `include`. |
| `sidebarPath` | bool | `true` | Whether to show the sidebar, auto-generated from the content hierarchy. There is no support for a custom, manually curated sidebar file — sort/label questions via `sidebar_position`/`sidebar_label` in their frontmatter instead. |
| `sidebarCollapsible` | bool | `true` | Whether sidebar categories can be collapsed. |
| `sidebarCollapsed` | bool | `true` | Whether sidebar categories start collapsed. |
| `sidebarDepth` | int | `5` | Maximum nesting depth shown in the sidebar. |
| `showLastUpdateAuthor` | bool | `false` | Whether to show who last updated the question. |
| `showLastUpdateTime` | bool | `true` | Whether to show when the question was last updated. |
| `breadcrumbs` | bool | `true` | Whether to show breadcrumbs above the question. |
| `tags` | array of strings, or string | `[]` | Predefined tags for the FAQ. |
| `onInlineTags` | `ignore`\|`log`\|`warn`\|`throw` | `warn` | What to do when a question uses a tag that isn't in the predefined `tags` list. |

## Content frontmatter

FAQ questions use the [generic content frontmatter](./frontmatter), with one override and one addition:

| Field | Type | Default | Description |
|---|---|---|---|
| `hide_table_of_contents` | bool | `true` | Overrides the generic default of `false` — questions hide the table of contents unless explicitly re-enabled. |
| `show_children` | bool | `false` | Renders a card grid linking to this question's direct children (title + description), useful for section landing pages. |



---
Last updated on 21/08/2026