Мета страницы
Тема отображает время последнего обновления и авторов страницы с помощью плагина @vuepress/plugin-git
, а также поддерживает кнопку «редактировать эту страницу».
Тема также предоставляет кнопки навигации для перехода к предыдущей и следующей страницам в зависимости от конфигурации боковой панели.
Информация на основе Git
vuepress-theme-hope
использует встроенный плагин @vuepress/plugin-git
для автоматического определения времени создания страницы, времени последнего обновления и участников.
Плагин будет автоматически генерировать время создания страницы и время последнего обновления из временной метки UNIX (мс) последней фиксации git
файла подкачки, а также создавать участников на основе записи фиксации.
Тема будет отображать время последнего обновления в соответствующем формате даты, а также всех участников страницы внизу страницы.
Совет
Тема будет использовать Date.toLocaleString(pageLang)
для автоматической локализации текста времени последнего обновления в соответствии с текущим языком.
Limitations
Since the contributors, last update time, and file creation time information are based on
git
, you can only enable it in agit
based project.Since related information are from git commits, they will only be displayed after the first commit for a given page, and will only be updated when some commits change that page.
Since the
git
plugin needs to call Git binary and involves file IO, this function will seriously affect the startup and hot update speed, so by default theme will not be enabled in devServer. Setplugins.git: true
orhotReload: true
in theme options if needed.
Изменить ссылку
Вы можете автоматически генерировать ссылки для редактирования для каждой страницы, установив следующие элементы в параметрах темы:
docsRepo
: ссылка на репозиторий документации, такая же, какrepo
по умолчанию.docsDir
: каталог документации в репозитории, по умолчанию корневой каталогdocsBranch
: ветка документации, по умолчанию"main"
Управление отображением
Чтобы скрыть эти элементы глобально, установите для соответствующих элементов ниже значение false
в параметрах темы. Вы также можете включить/отключить определенные страницы, установив эти элементы в YAML front matter
:
lastUpdated
: отображать ли время последнего обновления страницыcontributors
: показывать ли участников страницыeditLink
: отображать ли ссылку "edit page"