Мета страницы

Тема отображает время последнего обновления и авторов страницы с помощью плагина @vuepress/plugin-git, а также поддерживает кнопку «редактировать эту страницу».

Тема также предоставляет кнопки навигации для перехода к предыдущей и следующей страницам в зависимости от конфигурации боковой панели.

Информация на основе Git

vuepress-theme-hope использует встроенный плагин @vuepress/plugin-git для автоматического определения времени создания страницы, времени последнего обновления и участников.

Плагин будет автоматически генерировать время создания страницы и время последнего обновления из временной метки UNIX (мс) последней фиксации git файла подкачки, а также создавать участников на основе записи фиксации.

Тема будет отображать время последнего обновления в соответствующем формате даты, а также всех участников страницы внизу страницы.

Совет

Тема будет использовать Date.toLocaleString(pageLang) для автоматической локализации текста времени последнего обновления в соответствии с текущим языком.

Ограничения

1. Поскольку информация об участниках, времени последнего обновления и времени создания файла основана на git, вы можете включить ее только в проекте на основе git.

2. Поскольку соответствующая информация получена из коммитов git, они будут отображаться только после первого коммита для данной страницы и будут обновляться только тогда, когда некоторые коммиты изменят эту страницу.

3. Поскольку плагин git должен вызывать двоичный файл Git и использовать файловый ввод-вывод, эта функция серьезно повлияет на скорость запуска и горячего обновления, поэтому по умолчанию тема не будет включена в devServer. При необходимости установите plugins.git: true или hotReload: true в параметрах темы.

Изменить ссылку

Вы можете автоматически генерировать ссылки для редактирования для каждой страницы, установив следующие элементы в параметрах темы:

• docsRepo: ссылка на репозиторий документации, такая же, как repo по умолчанию.
• docsDir: каталог документации в репозитории, по умолчанию корневой каталог
• docsBranch: ветка документации, по умолчанию "main"

Управление отображением

Чтобы скрыть эти элементы глобально, установите для соответствующих элементов ниже значение false в параметрах темы. Вы также можете включить/отключить определенные страницы, установив эти элементы в YAML front matter:

• lastUpdated: отображать ли время последнего обновления страницы
• contributors: показывать ли участников страницы
• editLink: отображать ли ссылку "edit page"