---
title: "Author and publish documentation"
description: "Write docs in Git or the admin CMS, preview changes, publish revisions, and update search and sitemap outputs."
section: "Documentation platform"
version: "latest"
locale: "en"
updated: "2026-07-18T21:55:51.000Z"
---

# Author and publish documentation

Write docs in Git or the admin CMS, preview changes, publish revisions, and update search and sitemap outputs.

CrawlConsole documentation supports two authoring paths: repository Markdown for Git workflows and a web CMS for editorial workflows. Both feed the same public content index.

## Author in Git

Add Markdown files under `content/docs`. Frontmatter controls navigation, search, access, SEO, and sitemap behavior.

```markdown
---
title: "Page title"
description: "A concise page summary."
section: "Guides"
sectionOrder: 70
navigationOrder: 20
keywords: [keyword one, keyword two]
priority: 0.7
---

Write the page in Markdown.
```

Run the app locally and open `/docs` to preview repository content.

## Author in the CMS

Platform admins can open **Admin** and **Documentation** to:

- create a page;
- edit Markdown with a live preview;
- set the slug, section, locale, version, visibility, SEO, and sitemap fields;
- save drafts without changing the published page;
- publish a revision;
- restore an earlier revision;
- archive or delete CMS pages;
- review docs traffic, searches, and feedback.

A published CMS page overrides a repository page with the same slug, locale, and version. Draft edits remain private until the next publish action.

## Publish outputs

One publish action updates:

- the HTML page;
- sidebar and top-level documentation navigation;
- search results;
- the `search_docs` MCP tool;
- `.md`, `llms.txt`, and `llms-full.txt` exports;
- the dedicated docs sitemap;
- the changelog RSS feed when the page is in the Changelog section.

## Access and personalization

CMS pages can be public, authenticated, or admin-only. Public sitemap and agent exports include only public, indexable pages. Locale and version fields allow alternate published variants without duplicating the renderer.