Пишите статьи и организуйте коллекции

Shayan TaslimОбновлено

В Центре помощи статьи упорядочены по коллекциям. Для команды доступен многофункциональный редактор форматированного текста с внутренними ссылками, историей версий и настройками видимости.

Организация коллекций

Откройте Центр помощи → Статьи на боковой панели дашборда, чтобы управлять деревом навигации.

  • Создайте коллекцию. Нажмите Новая коллекция на верхней панели, укажите Название (до 255 символов; UserJot предлагает значок по мере ввода, пока вы не выберете его вручную), выберите Значок и нажмите Создать. Новые коллекции появляются внизу верхнего уровня.

  • Измените коллекцию. Щёлкните коллекцию правой кнопкой мыши и выберите Изменить…, чтобы обновить значок, название или Описание (до 500 символов).

  • Создавайте вложенные уровни и меняйте порядок. Перетаскивайте коллекции и статьи в дереве, чтобы менять их порядок или создавать вложенные уровни, либо щёлкните правой кнопкой мыши и выберите Переместить в. Коллекции можно вкладывать на глубину до трёх уровней.

  • Верхний уровень и статьи без размещения. Статьи на Верхнем уровне отображаются вне коллекций, и для них можно задать собственный значок (щелчок правой кнопкой мыши → Изменить значок…). Нажмите Новая статья на верхней панели, чтобы создать черновик без размещения в разделе Без коллекции. Такие статьи не отображаются в списке и не находятся через поиск, пока вы не разместите их на Верхнем уровне или в коллекции.

  • Удалите коллекцию. Щёлкните коллекцию правой кнопкой мыши и выберите Удалить…. Коллекции удаляются безвозвратно, минуя корзину. Если в коллекции есть статьи, выберите, куда их переместить: в другую коллекцию (Переместить статьи в), на Верхний уровень или в раздел Без коллекции (при перемещении в другую коллекцию старые URL удалённой коллекции будут перенаправлять на неё).

Работа в редакторе

У каждой статьи есть обязательный параметр Заголовок (до 255 символов), необязательный параметр Описание (до 500 символов; отображается на карточках и используется в метаописании) и редактор основного текста.

Нажмите / на новой строке, чтобы вставить блоки:

  • Текст, Заголовок (H2) и Подзаголовок (H3). Для заголовков автоматически создаются постоянные якоря разделов.

  • Маркированный список, Нумерованный список, Цитата, Блок кода (с выбором языка) и Разделитель.

  • Изображение (загрузите файлы с компьютера; нажмите на изображение, чтобы добавить Альтернативный текст или Подпись длиной до 500 символов каждый).

  • Таблица (создаётся таблица 3×3 с заголовочной строкой и плавающими элементами управления строками и столбцами).

  • Выноски Примечание, Совет и Предупреждение, а также сворачиваемые блоки Аккордеон (заголовки длиной от 1 до 200 символов). В редакторе панели управления выноски и аккордеоны нельзя вкладывать друг в друга (через API или при импорте HTML выноска может находиться внутри аккордеона, но выноска внутри выноски, аккордеон внутри выноски и аккордеон внутри аккордеона не допускаются).

  • Вставляйте видео с YouTube, Loom или Vimeo (либо вставьте отдельной строкой обычную ссылку на видео с одной из этих платформ).

Выделите текст, чтобы применить Полужирный, Курсив, Зачёркивание, Код, Клавиша (оформление сочетания клавиш) или добавить ссылку. Форматирование Код и Клавиша нельзя сочетать с другими видами встроенного форматирования, а текст Клавиша не может содержать < или >. Документы поддерживают до 1 МБ JSON, 512 КБ Markdown, 5 000 узлов и 32 уровней вложенности блоков.

Черновики сохраняются автоматически по мере ввода. Нажмите ⌘S / Ctrl+S, чтобы сохранить вручную; нажмите ⌘⇧\ / Ctrl+Shift+\, чтобы показать или скрыть панель со списком статей; переключите Предпросмотр в правом нижнем углу, чтобы увидеть статью глазами читателя; или нажмите Звук печати в левом нижнем углу, чтобы выбрать звуки механической клавиатуры (Alpaca, Cream, Mint, Mochi, Frost или Выкл.) и отрегулировать громкость.

Диалект Markdown центра справки

В REST API, на MCP-сервере, в функции Копировать страницу и в конечных точках .md используется Markdown с поддержкой GitHub, дополненный следующими возможностями:

  • Блоки выносок <Note>, <Tip> и <Warning>

  • Сворачиваемые разделы <Accordion title="...">

  • {#custom-id} в конце заголовка, чтобы закрепить постоянную ссылку-якорь

  • <kbd>...</kbd> для встроенного отображения клавиш

  • Внутренние ссылки в формате /articles/<slug> или /collections/<slug> (необязательно с #heading)

Нажмите кнопку ссылки на панели инструментов выделения, чтобы открыть окно Добавить ссылку. Ищите в центре справки статьи, коллекции и заголовки опубликованных статей (для поиска по заголовкам нужно не менее 2 символов; отображается до 8 результатов) или вставьте внешний URL https://. Если вставить URL одной из ваших статей справки, он станет внутренней ссылкой, которая продолжит работать, даже если изменится слаг целевой статьи.

Если связанная статья позже будет снята с публикации, перемещена в корзину или удалена, редактор выделит ссылку в тексте, чтобы вы могли её исправить. В списке На эту статью ссылаются на панели Статья справа отображаются до восьми опубликованных статей, ссылающихся на текущую.

Откройте панель Статья справа, чтобы настроить, как читатели будут находить статью:

Настройка

Описание

Видимость

Выберите Для всех (статья отображается в списке и результатах поиска, а также включена в llms.txt и Juno), Не в списке (доступна только по прямой ссылке; скрыта в навигации, поиске и Juno) или Для команды (доступна только вошедшим в систему внутренним администраторам и владельцам).

Коллекция

Разместите статью на Верхнем уровне, в коллекции или оставьте в разделе Без коллекции.

Ссылка

Нажмите /help/articles/<slug>, чтобы открыть окно Изменить ссылку (строчные латинские буквы, цифры и дефисы; до 60 символов). До первой публикации слаг соответствует заголовку, пока вы не измените его вручную. После публикации при изменении слага автоматически создаётся перенаправление со старого URL.

Показывать в поисковых системах

Разрешите или запретите индексацию этой статьи поисковыми системами. Для индексации статья также должна быть общедоступной и размещённой в коллекции, а центр справки должен иметь статус Опубликован.

Ключевые слова

Добавьте скрытые ключевые слова для текущего языка (до 50 ключевых слов, не более 64 символов каждое). Нажмите Enter или запятую, чтобы добавить каждое слово.

Также можно назначить Автора (или выбрать Без автора) в карточке статуса вверху правой панели.

Публикация, история и корзина

  • Опубликуйте. Нажмите Опубликовать (или Опубликовать изменения, сочетание клавиш ⌘↵). Перед публикацией появится предупреждение, если у изображений отсутствует альтернативный текст или есть неработающие внутренние ссылки. Обновляя опубликованную статью, отключите параметр Отметить как обновлённую для небольших исправлений опечаток, чтобы публичная дата обновления не изменилась.

  • Снимите с публикации. Откройте Другие действия (⋮) → Снять с публикации, чтобы убрать текущий язык из открытого доступа, сохранив его черновик и историю версий.

  • История версий. Выберите любую запись в разделе История на правой панели, чтобы просмотреть её без возможности редактирования (нажмите Esc, чтобы выйти из режима предпросмотра), а затем нажмите Восстановить эту версию, чтобы скопировать её в черновик (он останется неопубликованным, пока вы не нажмёте Опубликовать изменения).

  • Сравните переводы. При редактировании переведённой статьи включите параметр Сравнить на верхней панели (на широком экране), чтобы рядом отображался опубликованный оригинал с выделенными изменёнными, добавленными и удалёнными блоками.

  • Перемещение в корзину и восстановление. Откройте Другие действия (⋮) → Переместить в корзину, чтобы сразу удалить статью. Статьи в корзине можно восстановить в течение 30 дней; за ними сохраняются слаг и перенаправления. По истечении этого срока статьи удаляются безвозвратно. Открыв статью из корзины, вы увидите кнопку Восстановить из корзины.

Дальнейшие действия

Эта статья ответила на ваш вопрос?