Документерра: руководство пользователя

Получение ссылки на конкретный раздел справки

Когда ваш проект уже опубликован, вы можете просто скопировать URL-адрес страницы из адресной строки браузера (убедитесь, что страница не находится в режиме редактирования, так как это повлияет на URL-адрес). Обратите внимание, что необходимо копировать такие ссылки только из публикаций ваших проектов, а не из самих проектов, потому что проекты и закрытые публикации недоступны для читателей, а только для авторизованных в системе авторов.

URL-адрес страницы должен выглядеть следующим образом:

https://docs.hedronlabs.org/articles/#! documenterra-product-documentation/introducing-documenterra

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

В таких ситуациях можно использовать смарт-ссылки, которые не указывают на конкретную публикацию — они указывают на страницу из последней публикации проекта.