Version Packages

[fuma-nama]

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to dev, this PR will be updated.

Releases

[email protected]

Major Changes

• 2d8df75: Remove cwd option from remark-dynamic-content

  why: Use cwd from vfile

  migrate: Pass the cwd option from remark instead

• 92cb12f: Simplify Source API virtual storage.

  why: Improve performance

  migrate:

  - storage.write('path.mdx', { type: 'page', ... })
  - storage.readPage('page')
  + storage.write('path.mdx', 'page', { ... })
  + storage.read('page', 'page')

  Transformers can now access file loader options.

  load({
    transformers: [
      ({ storage, options }) => {
        options.getUrl();
        options.getSlugs();
      },
    ],
  });

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

• 2d8df75: Remove support for getTableOfContentsFromPortableText

  why: Sanity integration should be provided by 3rd party integrations

  migrate: Use built-in sources, or write a custom implementation

[email protected]

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

[email protected]

Major Changes

• 2d8df75: Replace nav.links option with secondary links

  why: A more straightforward API design

  migrate:

  <DocsLayout
  +  links={[
  +    {
  +      type: 'secondary',
  +      text: 'Github',
  +      url: 'https://github.com',
  +      icon: <GithubIcon />,
  +      external: true,
  +    },
  +  ]}
  -  nav={{
  -    links: [
  -      {
  -        icon: <GithubIcon />,
  -        href: 'https://github.com',
  -        label: 'Github',
  -        external: true,
  -      },
  -    ],
  -  }}
  >
    {children}
  </DocsLayout>

Patch Changes

• Updated dependencies [2d8df75]
• Updated dependencies [92cb12f]
• Updated dependencies [f75287d]
• Updated dependencies [2d8df75]
  • [email protected]

[email protected]

Patch Changes

• Updated dependencies [2d8df75]
• Updated dependencies [92cb12f]
• Updated dependencies [f75287d]
• Updated dependencies [2d8df75]
  • [email protected]

[email protected]

Patch Changes

• Updated dependencies [f75287d]
  • [email protected]

[email protected]

Patch Changes

• Updated dependencies [2d8df75]
• Updated dependencies [92cb12f]
• Updated dependencies [f75287d]
• Updated dependencies [2d8df75]
  • [email protected]

[email protected]

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
fumadocs	⬜️ Ignored (Inspect)	Visit Preview		Apr 17, 2024 4:22am