Параметры копирования
Предоставьте читателям простые способы копирования контента вашей документации.
Настройки#
| Настройка | Что она делает |
|---|---|
| Кнопка копирования страницы | Добавляет кнопку «Копировать страницу» — копирует всю страницу в формате markdown |
| Копировать markdown | Показывает опцию копирования markdown для блоков кода |
Как включить#
- Откройте ваш сайт документации.
- Панель инструментов → Дизайн → вкладка Контент.
- Включите нужные опции копирования.
- Сохраните.
Кнопка копирования страницы#
Добавляет кнопку (обычно в верхней части страницы), которая копирует все содержимое страницы в виде исходного markdown.
Случаи использования:
- Читатели, которые хотят вставить содержимое страницы в подсказку для ИИ (например, ChatGPT, Claude) для дальнейшего анализа.
- Команды, которые хотят быстро скопировать документацию во внутренние инструменты.
- Технические писатели, которые ссылаются на вашу документацию при написании собственной.
Копирование Markdown в блоках кода#
При включении, каждый блок кода отображает небольшой значок "копировать". Нажатие на него копирует исходный код.
Это стандартная функция пользовательского опыта для разработчиков. Большинство разработчиков ожидают ее — включение этой функции устраняет трения для ваших наиболее технических читателей.
Совет: Это отслеживается как событие в Events Analytics, поэтому вы можете видеть, какие примеры кода копируются чаще всего.
Сделайте вашу документацию достойной копирования. Подключите свой репозиторий GitHub →