1.1.20 • Published 3 years ago
vuepress-theme-stack v1.1.20
VuePress Theme "Stack"
Тема сервиса для документации компании \"Стек\".
Использование
Устанавливаем тему с помощью команды:
npm install vuepress-theme-stack --save
Конфигурация
breadcrumbs
- type:
bool
- default:
undefined
Отображение хлебных крошек.
Элементы хлебных крошек берутся из заголовка статьи или frontmatter
.
titleTag
- type:
bool|object
- default:
undefined
Параметр | Описание |
---|---|
siteTitle | Заголовок сайта |
selfHome | Подзаголовок главной страницы |
self404 | Подзаголовок страницы со статусом 404 |
Тег заголовка сайта <title>Document</title>
.
Элементы заголовка берутся из заголовка статьи или frontmatter
.
search
- type:
object
- default:
undefined
Параметр | Описание |
---|---|
full | Вид поиска (true - во всех разделах, false - только в текущем) |
placeholder | Заполнитель поля поиска |
Настройки полнотекстового поиска.
Примеры
Настраиваем конфигурацию сервиса:
const { getNavLinks, getHomeLinks, getSidebarLinks, getFooterLinks } = require('./utils')
module.exports = {
title: 'HELP',
description: 'Документация программного обеспечения компании "Стек"',
// Расположение собранного проекта
dest: './dist',
// Настройки постоянных ссылок
base: '/',
permalink: '/:regular',
// Дополнительные настройки страницы
head: [
[ 'meta', { name: 'viewport', content: 'width=device-width, initial-scale=1' } ],
[ 'link', { rel: 'icon', href: '/assets/img/favicon.png' } ]
],
// Локализация
locales: { '/': { lang: 'ru-RU' } },
// Конфигурация темы
theme: 'stack',
themeConfig: {
logo: '/assets/logo.svg',
// Хлебные крошки
breadcrumbs: true,
// Заголовок страницы
titleTag: {
siteTitle: 'Компания "Стек"',
selfHome: 'Главная',
self404: 'Страница не найдена'
},
// Поиск
search: {
full: false,
placeholder: 'Поиск ...'
},
nav: getNavLinks(),
sidebar: getSidebarLinks(),
home: getHomeLinks(),
footer: getFooterLinks()
}
}
Настраиваем главную страницу:
module.exports = { getHomeLinks }
/**
* Возвращает структурированный список ссылок для главной страницы.
*
* @returns array
*/
function getHomeLinks() {
return [
{
title: 'Сервисы',
slug: 'services',
columns: 2,
items: [
{
title: 'Личный кабинет ФЛ',
description: 'Руководства пользователя',
icon: '/assets/img/icons/icon-lk_fl.svg',
link: '/lk/fl/'
},
{
title: 'Личный кабинет ЮЛ',
description: 'Руководства пользователя',
icon: '/assets/img/icons/icon-lk_ul.svg',
link: '/lk/ul/'
}
]
},
{
title: 'Мобильные приложения',
slug: 'applications',
columns: 3,
items: [
{
title: 'Стек-ЖКХ',
description: 'Руководства пользователя',
icon: '/assets/img/icons/icon-app_lk.png',
link: '/mp/lk/'
}
]
}
];
}
Настраиваем подвал:
module.exports = { getFooterLinks }
/**
* Возвращает содержание подвала.
*
* @return Object
*/
function getFooterLinks() {
return {
text: '© 1993 − ' + new Date().getFullYear() + ' Группа компаний "Стек"',
link: 'https://stack-it.ru',
social: getSocialLinks().items
};
}
Дополнительная информация
1.1.20
3 years ago
1.0.19
3 years ago
1.0.20
3 years ago
1.0.18
3 years ago
1.0.17
3 years ago
1.0.16
3 years ago
1.0.15
3 years ago
1.0.14
3 years ago
1.0.13
3 years ago
1.0.12
3 years ago
1.0.11
3 years ago
1.0.10
3 years ago
1.0.9
3 years ago
1.0.8
3 years ago
1.0.7
3 years ago
1.0.6
3 years ago
1.0.5
3 years ago
1.0.4
3 years ago
1.0.3
3 years ago
1.0.2
3 years ago
1.0.1
3 years ago
1.0.0
3 years ago