fumadocs-typescript 2.0.0

npm / fumadocs-typescript / 2.0.0 source ↗

Major Changes

• f75287d: Introduce fumadocs-docgen package.

  Offer a better authoring experience for advanced use cases.

  • Move remark-dynamic-content and remark-install plugins to the new package fumadocs-docgen.
  • Support Typescript generator by default

  Usage

  Add the remarkDocGen plugin to your remark plugins.

  import { remarkDocGen, fileGenerator } from "fumadocs-docgen";
  
  remark().use(remarkDocGen, { generators: [fileGenerator()] });
  

  Generate docs with code blocks.

  ```json doc-gen:<generator>
  {
    // options
  }
  ```
  

  Migrate

  For remarkDynamicContent, enable fileGenerator and use this syntax:

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

  For remarkInstall, it remains the same:

  import { remarkInstall } from "fumadocs-docgen";