UnieAI Documentation

Getting Started

Set up your environment and publish your first MDX doc page.

Getting started with UnieAI docs

Use this quickstart to add or edit documentation alongside the app.

1. Run the site locally

pnpm install
pnpm dev

Then open http://localhost:3000/en/docs to confirm the docs shell renders.

2. Create a new doc

  1. Add a file in content/docs/en. The filename becomes the route.
  2. Supply frontmatter so it shows up in the sidebar navigation:
---
title: API Keys
description: Where to create and rotate UnieAI API keys.
order: 2
---
  1. Write your content in MDX. You can mix Markdown and JSX components when needed.

Internal links keep the locale prefix:

  • [Overview](/en/docs)
  • [Model deployment guide](/en/docs/deployment) (create deployment.mdx first)

External links open in a new tab, so you do not need to add target or rel.

4. Add a localized version

Mirror the file under content/docs/zh-TW. If a slug exists for both locales, the locale switcher in the URL will respect the matching path.

5. Publish

Docs are bundled with the Next.js build. Once merged, the MDX files deploy with the rest of the site—no extra infrastructure needed.

Example: embedding JSX

export function InlineBadge({ children }) {
  return (
    <span className="rounded-full bg-indigo-500/10 px-2 py-1 text-[11px] font-semibold text-indigo-100">
      {children}
    </span>
  );
}

<InlineBadge>Edge Ready</InlineBadge>

Keep React components light so they render well in the static build.