Remark Docs Generation

Usage

npm install fumadocs-docgen

Add the remark plugin.

source.config.ts

import { remarkDocGen, fileGenerator } from 'fumadocs-docgen';
import { defineConfig } from 'fumadocs-mdx/config';
 
export default defineConfig({
  mdxOptions: {
    remarkPlugins: [[remarkDocGen, { generators: [fileGenerator()] }]],
  },
});

File Generator

It copies the content from a file to the document (mdast tree) and forms a paragraph.

```json doc-gen:file
{
  "file": "./my/file.txt"
}
```

As Code Block

Copy the content into a code block.

```json doc-gen:file
{
  "file": "./my/file.txt",
  "codeblock": true
}
```

Or to specify the programming language and meta string:

```json doc-gen:file
{
  "file": "./my/file.txt",
  "codeblock": {
    "lang": "ts",
    "meta": "title=\"Hello\""
  }
}
```

Remark Docs Generation

Usage

File Generator

As Code Block

On this page