Docsalot home pagelight logo
  1. Quickstart Guide

Hero Image

After you complete this guide, you’ll have a live documentation site, your first publish, and clear next steps for API docs, AI-native discovery, and layout customization.

​
Deploy your documentation site

Go to docsalot.dev/documentation and click New documentation to get started.

After creating the docs, make a quick edit in the web editor and publish it. Your documentation site will go live at your-project.docsalot.dev.

​
View your deployed site

Your documentation site is now deployed at https://<your-project-name>.docsalot.dev.

Find your exact URL on the Overview page of your documentation.

Your site is ready to view immediately. Use this URL for testing and sharing with your team. Before sharing it broadly, you may want to add a custom subdomain.

​
Make your first change

1

Open the web editor

Navigate to the web editor in your dashboard.

2

Edit a page

Open index.mdx and update the description in the frontmatter:

theme={null}
---
title: "Introduction"
description: "Your custom description here"
---
3

Publish

Click the Publish button in the top-right of the web editor toolbar.

4

View live

Use the view-live button at the top of the editor, then refresh your documentation site to see the change live.

​
Next steps

​
Learn More

​
Common Guides

Select from the following guides to learn more about how Docsalot can best suit your documentation.

Publish

Learn how to publish your documentation changes.

Global Settings

Customize your theme, branding, navigation, and top-level documentation settings.

Page Modes

Control whether a page uses the default docs shell, a wider canvas, or a custom layout mode.

Writing Content

Learn how to structure pages, format content, and reuse documentation patterns.

​
Advanced Topics

Dive deeper into advanced guides to take your documentation to the next level.

Agent-first onboarding

Set up the CLI and Docsalot skill so Claude Code or Codex can work directly in your docs repo.

Components

Use Docsalot components for layouts, callouts, cards, tabs, and code examples.

Document APIs

Add interactive API docs and playgrounds to your documentation.

Analytics

Discover how users are interacting with your documentation.