The problem​

Documentation gets outdated. It's one of the most universal frustrations in software development. You ship a feature, update the code, and forget to update the docs. Or worse, you update them but miss a renamed parameter or a changed return type. Over time, the gap between your code and your docs grows until developers stop trusting the documentation entirely.

We built Docsgen to eliminate this class of problem.

The mental model​

Docsgen splits documentation into two layers:

• The narrative - You write this. It explains the general idea, when to use something, how things fit together. This requires human understanding and cannot be generated.
• The technical details - Method tables, parameter types, return values, import statements, type definitions. These come from @import directives that read your actual source code.

When you change your code, the technical details update automatically on the next build. The narrative stays as you wrote it. No manual sync required.

How it works​

1. Install​

npm install @docsgen/core @docsgen/docusaurus

2. Configure​

Add the plugin to your Docusaurus config:

plugins: [
  [
    "@docsgen/docusaurus",
    {
      id: "api",
      outDir: "docs/api",
      packages: [
        {
          title: "My Package",
          dir: "./packages/my-package",
          entryPath: "src/index.ts",
        },
      ],
    },
  ],
];

3. Write living docs​

In any MDX file, use @import to embed API fragments:

## Methods

(@import core Request type=methods&display=table)

## Parameters

(@import core Request type=parameters&display=block)

These directives are replaced with real, generated content from your codebase at build time. The output stays accurate as long as the code compiles.

What's next​

This is just the beginning. We're working on:

• More display modes and component types for the @import directive
• Additional framework integrations beyond Docusaurus
• Interactive playground for trying out docsgen without installing anything
• Better theme customization for generated pages

Get started​

• Read the documentation
• View on GitHub
• Install and try it

We'd love your feedback. Open an issue, submit a PR, or just star the repo if you find it useful.