Writing

Get started with creating rich documentation in APIToGo using Markdown and MDX. This guide covers the essentials to help you begin documenting your project.

Quick Start

1. Create a markdown file in apitogo/portal/pages/
2. Add frontmatter with title and metadata
3. Write content using Markdown or MDX

The page shows in the sidebar on its own.

Basic Document Structure

Code
---
title: My Document
sidebar_icon: file-text
---

Your content goes here using standard Markdown syntax.

Adding to Navigation

The sidebar is built from the files: every page in apitogo/portal/pages/ (or the folders portal.docs.content names) is listed, and each folder becomes a section. A folder's index page comes first, then pages with an order, lowest first, then the rest by name:

Code
---
title: Authentication
order: 2
---

A page with draft: true is left out of deployed portals.

File Organization

Organize your documentation files in logical directories:

Code
pages/
├── getting-started/
│   ├── installation.md
│   └── quick-start.md
├── guides/
│   ├── authentication.md
│   └── deployment.md
└── api/
    └── reference.md

What's Next?

Explore the detailed guides to enhance your documentation:

• Markdown Overview - Complete markdown syntax reference
• Frontmatter - Document metadata and configuration
• MDX - Interactive components in markdown
• Admonitions - Callouts and alerts
• Code Blocks - Syntax highlighting and features