NextGuide

Documentation blocks

Author-oriented MDX blocks for guides, callouts and navigation.

Documentation blocks

Steps

Preview

  1. Install

    Add NextGuide to your Next.js project.

  2. Initialize

    Run the CLI to generate documentation.

  3. Write

    Edit your content/docs/*.mdx files.
import { Steps, Step, Callout, LinkCards, LinkCard } from "nextguide/blocks"

<Steps>
  <Step title="Install">Add NextGuide to your Next.js project.</Step>
  <Step title="Initialize">Run the CLI to generate documentation.</Step>
  <Step title="Write">Edit your content/docs/*.mdx files.</Step>
</Steps>

Callout

Preview

Tip

NextGuide installs its UI through one package.
import { Steps, Step, Callout, LinkCards, LinkCard } from "nextguide/blocks"

<Callout kind="tip" title="Tip">NextGuide installs its UI through one package.</Callout>
Preview
MDXWrite documentation pagesOpenAPIDocument API endpoints
import { Steps, Step, Callout, LinkCards, LinkCard } from "nextguide/blocks"

<LinkCards>
  <LinkCard title="MDX" href="/docs/mdx" description="Write documentation pages" />
  <LinkCard title="OpenAPI" href="/docs/openapi" description="Document API endpoints" />
</LinkCards>