// Use when generating or auditing documentation in Docusaurus format — covers config, directory structure, frontmatter conventions, and build commands.
Use when generating or auditing documentation in MkDocs format — covers config, directory structure, frontmatter conventions, and build commands.
Use when generating or auditing documentation in plain Markdown format — covers config, directory structure, frontmatter conventions, and build commands.
Use when generating or auditing documentation in Sphinx format — covers config, directory structure, frontmatter conventions, and build commands.
Use when generating or auditing documentation in VitePress format — covers config, directory structure, frontmatter conventions, and build commands.
Use when writing, auditing, or generating documentation for projects in unsupported languages — covers docstring conventions, API doc extraction, and generic heuristic patterns.
Use when writing, auditing, or generating documentation for Go projects — covers docstring conventions, API doc extraction, and Go-specific patterns.
| name | fw-docusaurus |
| description | Use when generating or auditing documentation in Docusaurus format — covers config, directory structure, frontmatter conventions, and build commands. |
Detected when docusaurus.config.js or docusaurus.config.ts exists in project root.
Key fields to extract:
// docusaurus.config.js
module.exports = {
title: 'My Project',
presets: [
['@docusaurus/preset-classic', {
docs: {
sidebarPath: require.resolve('./sidebars.js'),
routeBasePath: 'docs',
},
}],
],
};
// sidebars.js
module.exports = {
docs: [
'intro',
{
type: 'category',
label: 'API Reference',
items: ['api/auth', 'api/users'],
},
],
};
docs.sidebarPath: path to sidebar configuration.md, relative to docs/)docs.routeBasePath: URL prefix (default docs)docs/ directory (or configured via docs.path in presets).
Parse sidebars.js entries. Each string item maps to docs/<item>.md. Categories organize items hierarchically.
| Source | Doc Candidate |
|---|---|
src/auth/login.ts | docs/api/auth.md or docs/api/auth/login.md |
src/hooks/useAuth.ts | docs/api/hooks/useAuth.md |
Docusaurus supports Markdown and MDX with YAML frontmatter:
---
id: auth
title: Auth Module
sidebar_label: Authentication
sidebar_position: 1
---
# Auth Module
Brief description.
## API Reference
### `login(username, password)`
Authenticates a user and returns a session token.
| Name | Type | Description |
|------|------|-------------|
| `username` | `string` | The user's login name |
| `password` | `string` | The user's password |
**Returns:** `Session` — An authenticated session object.
:::tip
Use environment variables for credentials in production.
:::
```tsx
const session = await login("admin", "secret");
## Docusaurus-Specific Content
Valid Docusaurus content — do not flag as quality issues:
- `:::note/tip/info/caution/danger` admonitions
- MDX components and JSX in markdown (e.g., `<Tabs>`, `<CodeBlock>`)
- `import` statements at the top of `.mdx` files
- YAML frontmatter with Docusaurus fields (`id`, `sidebar_label`, `sidebar_position`, `slug`)
- `{@link}` and `{@see}` JSDoc references in MDX