fumadocs

The beautiful docs framework for Next.js. Alternative to Nextra

MIT License

Downloads
1.6K
Stars
1.5K

Bot releases are hidden (Show)

fumadocs - [email protected]

Published by fuma-nama 4 months ago

Patch Changes

  • 78acd55: Use full mode on docs pages by default on OpenAPI generated pages
fumadocs - [email protected]

Published by fuma-nama 4 months ago

fumadocs - [email protected]

Published by fuma-nama 4 months ago

fumadocs - [email protected]

Published by fuma-nama 4 months ago

Minor Changes

  • 318eaf9: Redesign TOC popover: Make the TOC Popover trigger a part of navbar.
  • ea22d04: Improve dynamic sidebar: Improve animation & close delay

Patch Changes

  • 2f2d9cf: Improve footer: Use card-style buttons to match the other buttons
  • bcc9f91: Added a new colors for API info badge, so POST, PATCH requests are different from PUT.
  • 2f2d9cf: Improve OpenAPI styles
  • Updated dependencies [b70ff06]
fumadocs - [email protected]

Published by fuma-nama 4 months ago

Patch Changes

  • 318eaf9: Support generating files per operation
fumadocs - [email protected]

Published by fuma-nama 4 months ago

Patch Changes

  • 7601b35: Move DocsLayout options to layout.config.tsx
fumadocs - [email protected]

Published by fuma-nama 4 months ago

Minor Changes

  • b70ff06: Support !name to hide pages on meta.json
fumadocs - [email protected]

Published by fuma-nama 4 months ago

Patch Changes

  • 2a5db91: Add timeout for hovering after collapsed the sidebar
  • 3e98d7d: Support full mode on pages
  • d06c92a: Support transparentMode on secondary (docs) navbar
  • 3bdc786: Support Fumadocs OpenAPI 3.1.0
  • d06c92a: Fix hot keys order
fumadocs - [email protected]

Published by fuma-nama 4 months ago

Minor Changes

  • 3bdc786: Support JavaScript request example
  • 3bdc786: Support generating Authorization (security) section
fumadocs - [email protected]

Published by fuma-nama 4 months ago

fumadocs - [email protected]

Published by fuma-nama 4 months ago

fumadocs - [email protected]

Published by fuma-nama 4 months ago

Patch Changes

fumadocs - [email protected]

Published by fuma-nama 4 months ago

Major Changes

  • 284a571: Renew Generate API.

    why: Improve flexibility.

    migrate:

    Removed the render option from generate, generateFiles and generateTags, use frontmatter to customise frontmatter, imports to customise imports.

  • 284a571: Support Custom MDX Renderer.

    why: Allow people to customise how the MDX file is generated.

    migrate:

    Changed the output of MDX files, the new structure requires components:

    • Root
    • API
    • APIInfo
    • APIExample
    • Responses
    • Response
    • ExampleResponse
    • TypeScriptResponse
    • Property
    • ObjectCollapsible
    • ResponseTypes
    <API>
    
    <APIInfo method={"GET"} route={"/pets/{petId}"}>
    
    ## Info for a specific pet
    
    ### Path Parameters
    
    <Property name={"petId"} type={"string"} required={true} deprecated={false}>
    
    The id of the pet to retrieve
    
    </Property>
    
    | Status code | Description                          |
    | ----------- | ------------------------------------ |
    | `200`       | Expected response to a valid request |
    | `default`   | unexpected error                     |
    
    </APIInfo>
    
    <APIExample>
    
    ```bash title="curl"
    curl -X GET "http://petstore.swagger.io/pets/string"
    ```
    
    <Responses items={["200","default"]}>
    
    <Response value={"200"}>
    
    <ResponseTypes>
    
    <ExampleResponse>
    
    ```json
    {
      "id": 0,
      "name": "string",
      "tag": "string"
    }
    ```
    
    </ExampleResponse>
    
    <TypeScriptResponse>
    
    ```ts
    export interface Response {
      id: number;
      name: string;
      tag?: string;
    }
    ```
    
    </TypeScriptResponse>
    
    </ResponseTypes>
    
    </Responses>
    
    </APIExample>
    
    </API>
    
fumadocs - [email protected]

Published by fuma-nama 4 months ago

fumadocs - [email protected]

Published by fuma-nama 4 months ago

Patch Changes

  • b4856d1: Fix createGetUrl wrong locale position
fumadocs - [email protected]

Published by fuma-nama 4 months ago

fumadocs - [email protected]

Published by fuma-nama 4 months ago

Patch Changes

fumadocs - @fumadocs/[email protected]

Published by fuma-nama 4 months ago

Patch Changes

fumadocs - [email protected]

Published by fuma-nama 4 months ago

Patch Changes

  • bcc05d6: Fix docs typo
fumadocs - [email protected]

Published by fuma-nama 4 months ago

Patch Changes

  • a39dbcb: Export loadFiles from Source API