Получение страниц в формате Markdown

Каждую страницу на вашем портале Документерры можно получить в виде чистого Markdown, добавив .md к ID страницы в её URL-адресе.

Эта функциональность помогает сделать вашу документацию удобной для ИИ и предназначена для работы с ИИ-агентами, инструментами для разработчиков на базе LLM и любой автоматизацией, которой необходимо считывать контент документации без парсинга HTML.

Формат URL-адреса

Чтобы получить Markdown-версию страницы, используйте следующий шаблон URL-адреса:

https://yourportal.documenterra.net/articles/{project-id}/{topic-id}.md

Пример:

Regular topic URL https://yourportal.documenterra.net/articles/#!sdk/installation
Markdown URL https://yourportal.documenterra.net/articles/sdk/installation.md
Не включайте символы #! (хэшбенг) в URL-адрес. Для получения Markdown используются только чистые URL-адреса. URL-адрес вида .../articles/#!sdk/installation.md не вернет Markdown-контент.

Что содержит ответ в формате Markdown

Возвращаемый Markdown включает в себя полное содержимое страницы — заголовки, абзацы, примеры кода, ссылки на изображения, таблицы и списки — а также ее метаданные в виде чистого простого текста без оформления. Контент, динамически генерируемый скриптами, исключается.

Пример:

Скопировать код
Markdown
---
title: Начало работы
id: nachalo-raboty
project: Руководство по эксплуатации
url: https://yourportal.clickhelp.co/articles/project-my-manual/nachalo-raboty
updated: 2026-03-20T15:01:48Z
---

# Начало работы
 
Это пример стартовой страницы для вашего портала документации.
 ## С чего начать?
...

Когда использовать URL-адреса Markdown

URL-адреса страниц в формате Markdown наиболее полезны в следующих сценариях:

  • Ссылки для llms.txt — при создании файла llms.txt для вашего портала давайте ссылки на URL-адреса с расширением .md, чтобы ИИ-агенты могли напрямую считывать контент каждой указанной страницы.
    ИИ-агенты считаются неавторизованными (анонимными) пользователями, поэтому используйте в файле llms.txt ссылки на публичные публикации.
  • Рабочие процессы ИИ-агентов — используйте URL-адреса с .md в Zapier, n8n или аналогичных инструментах для получения контента страницы, например, в качестве контекста для ответов, генерируемых ИИ.
  • Пользовательские интеграции — любые интеграции, которым необходимо программно обрабатывать контент документации.

Связь с llms.txt

Конвенция llms.txt рекомендует сайтам с документацией предоставлять Markdown-версии своих страниц наряду с файлом llms.txt для вашего портала. Файл llms.txt служит картой; URL-адреса с расширением .md предоставляют контент для каждого пункта. Вместе они дают ИИ-инструментам полноценный и простой путь к вашей документации.

Копирование Markdown-версии страницы из интерфейса

Вы также можете скопировать Markdown-контент любой страницы прямо из интерфейса портала Документерры. Это полезно, когда вам нужно быстро получить контент страницы без необходимости вручную составлять URL-адрес.

Чтобы скопировать контент страницы в формате Markdown, откройте страницу и нажмите Скопировать Markdown как на скрипшотах ниже.

Современный шаблон читательского интерфейса (Next):

Опция Скачать страницу как Markdown в современном интерфейсе.

Классический шаблон интерфейса читателя (Clear Sky):

Опция Скачать страницу как Markdown в классическом интерфейсе.

Отличие от метода с использованием URL-адреса заключается в том, что скопированный Markdown содержит только контент страницы — метаданные в него не включаются.