hanzoai/docs
2
0
Fork 0
mirror of https://github.com/hanzo-docs/docs.git synced 2026-10-27 09:19:53 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
Files
usage-docs
docs/packages/typescript/CHANGELOG.md
T

9.4 KiB
Raw Permalink Blame History

fumadocs-typescript

5.2.6

Patch Changes

5.2.5

Patch Changes

5.2.4

Patch Changes

5.2.3

Patch Changes

5.2.2

Patch Changes

5.2.1

Patch Changes

5.2.0

Minor Changes

Patch Changes

5.1.5

Patch Changes

5.1.4

Patch Changes

5.1.3

Patch Changes

5.1.2

Patch Changes

5.1.0

Minor Changes

  • f6cecbf: Use Universal Shiki configuration for Markdown renderer

Patch Changes

5.0.1

Patch Changes

5.0.0

Major Changes

  • 9a3e2e8: Require async for generator.generateDocumentation()

    This is necessary to support async cache adapter.

  • 9a3e2e8: Remove deprecated APIs

    • removed standalone generateDocumentation() function, create a generator instead.
    • removed generateFiles & MDX generation APIs, use remarkAutoTypeTable instead.

  • 9a3e2e8: Require explicit cache

    Previously, we enabled file system cache by default, but the directory is not customisable and only support Next.js.

    Now, cache is disabled by default and require explicit declaration.

    Update all your createGenerator() calls:

    import {
  createGenerator,
  createFileSystemGeneratorCache,
} from "fumadocs-typescript";

const generator = createGenerator({
  // add this!
  cache: createFileSystemGeneratorCache(".next/fumadocs-typescript"),
});

Patch Changes

4.0.14

Patch Changes

4.0.13

Patch Changes

4.0.12

Patch Changes

4.0.11

Patch Changes

4.0.10

Patch Changes

4.0.9

Patch Changes

4.0.8

Patch Changes

4.0.7

Patch Changes

  • 45c7531: Type Table: Support displaying parameters & return types
  • 4082acc: Redesign Type Table

4.0.6

Patch Changes

  • 1b7bc4b: Add @types/react to optional peer dependency to avoid version conflict in monorepos

4.0.5

Patch Changes

  • a6c909b: Removed unused devDependencies and migrated from fast-glob to tinyglobby

4.0.4

Patch Changes

  • 6b04eed: Fix errors on special keys
  • a1f3273: Lazy load compiler instance

4.0.3

Patch Changes

  • 3a5595a: Support deprecated properties in Type Table

4.0.2

Patch Changes

  • 38117c1: add null | undefined to optional props in an object type

4.0.1

Patch Changes

  • f67d20f: Fix remark-auto-type-table doesn't render required property

4.0.0

Major Changes

  • b83d946: Use createGenerator API

    Create a generator instance:

    import { createGenerator } from "fumadocs-typescript";

const generator = createGenerator(tsconfig);

    Refactor:

    import { remarkAutoTypeTable, createTypeTable } from 'fumadocs-typescript';

generateDocumentation('./file.ts', 'MyClass', fs.readFileSync('./file.ts').toString())
generateMDX('content', {...})
generateFiles({...})
const processor = createProcessor({
    remarkPlugins: [remarkAutoTypeTable],
});

const AutoTypeTable = createTypeTable()
return <AutoTypeTable {...props} />

    To:

    import { AutoTypeTable, remarkAutoTypeTable } from "fumadocs-typescript";

generator.generateDocumentation({path: './file.ts'}, 'MyClass')
generateMDX(generator, 'content', { ... })
generateFiles(generator, { ... })
const processor = createProcessor({
    remarkPlugins: [
        [remarkAutoTypeTable, { generator }],
    ],
});

return <AutoTypeTable generator={generator} {...props} />

    This ensures the compiler instance is always re-used.

3.1.0

Minor Changes

  • 42d68a6: Support remarkAutoTypeTable plugin, deprecate MDX generator in favour of new remark plugin

Patch Changes

  • 5d0dd11: Support overriding renderMarkdown function

3.0.4

Patch Changes

  • 7608f4e: Support showing optional properties on TypeTable

3.0.3

Patch Changes

3.0.2

Patch Changes

  • c042eb7: Fix private class members

3.0.1

Patch Changes

3.0.0

Major Changes

  • f9adba6: Return an array of doc entry in generateDocumentation

Minor Changes

  • f9adba6: Support inline type syntax in AutoTypeTable type prop
  • f9adba6: Support createTypeTable for shared project instance

Patch Changes

2.1.0

Minor Changes

  • 3a2c837: Disable cache on program-level

Patch Changes

2.0.1

Patch Changes

2.0.0

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";

1.0.2

Patch Changes

  • 77b5b70: Fix compatibility problems with Typescript 5.4.3

1.0.1

Patch Changes

  • f4aa6b6: Ignore fields marked with @internal tag

1.0.0

Major Changes

  • 321d1e1f: Support markdown in type description

Minor Changes

  • 722c2d6e: Support generating MDX files
Reference in New Issue View Git Blame Copy Permalink