Authoring Guide · Adding Content

Author Studio

Local yarn-dev editor for creating and editing documentation without shipping to production

Updated Aug 23, 2026 · 3 min read

Development only

Author Studio runs exclusively with yarn dev / npm run dev. It is not included in production builds or the static GitHub Pages export. After you save, you still commit and push the files yourself.

Author Studio

Author Studio is a Notion-style editor for this knowledge base. It writes the same MDX your docs already use: frontmatter, callouts, terminals, mermaid fences, DocImage, tabs, and the rest of the authoring components.

How to open it

  1. Run yarn dev (or npm run dev)
  2. Open Author in the top navigation, or click Edit in studio on any doc page
  3. The localhost author API listens on 127.0.0.1:4317 and is never exported

If the studio says it is offline, the dev wrapper did not start. Use the dev script, not next dev by itself.

What you can do

  • Create a section or subsection (a folder under content/docs, including nested paths like projects/AIForge)
  • Create a new document with correct frontmatter
  • Set State to published or draft in the Meta panel, or on a section / subsection in the docs tree. Drafting an overview.mdx hides that folder and every nested MDX file in production. Drafts stay in the repo. Existing docs with no state field are published.
  • Edit an existing document as blocks or as raw MDX
  • Insert features with /: headings, lists, callouts, highlight, terminal, code, mermaid, images, video, YouTube, tabs, Excalidraw
  • Drag and drop (or paste) images. The studio stores them under public/assets/docs/images/... and runs the same image optimizer as yarn dev
  • Preview mermaid. Save runs build:mermaid, which builds new SVGs and deletes unused ones

Saving

Save writes the MDX file and prepares images / mermaid artifacts. Contentlayer picks up the file while yarn dev is running.

You are responsible for git add, commit, and push. The studio never publishes.

Editing existing docs safely

If you open a document and save without changing it, the original MDX is written back unchanged. Edited blocks are serialized in the project’s usual MDX style. Complex HTML tables and unknown JSX stay in a Preserved MDX block so they are not rewritten.

Use MDX source when you want full control over the file.

Shortcuts

  • / at the start of a paragraph opens the command menu
  • Select text to format it: bold, italic, color, highlight, link, or alignment
  • Enter stays in the same block and adds a new line
  • Ctrl+Z / Cmd+Z undo, Ctrl+Y or Ctrl+Shift+Z redo
  • Ctrl+S / Cmd+S saves
  • Hide the docs tree or document panel to get more writing space
  • Hover a folder in the tree and click + to add a doc there
  • Drag the handle to reorder blocks
  • Drop images anywhere on the editor canvas

Next steps