@ampernic/vitepress-theme-alt-docs 0.1.1 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +61 -0
- package/dist/components/ADProductsSidebar.vue +1 -1
- package/package.json +6 -7
package/README.md
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# @ampernic/vitepress-theme-alt-docs
|
|
2
|
+
|
|
3
|
+
Shared VitePress тема для сайтов документации ALT Linux. Включает компоненты, composables и конфигурационные хелперы — всё необходимое для запуска версионированного мультисайта документации на VitePress.
|
|
4
|
+
|
|
5
|
+
## Установка
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @ampernic/vitepress-theme-alt-docs
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Использование
|
|
12
|
+
|
|
13
|
+
### Theme
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
// .vitepress/theme/index.ts
|
|
17
|
+
import Theme from '@ampernic/vitepress-theme-alt-docs'
|
|
18
|
+
export default Theme
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
### Config helpers
|
|
22
|
+
|
|
23
|
+
```ts
|
|
24
|
+
// .vitepress/config.ts
|
|
25
|
+
import { defineConfig } from 'vitepress'
|
|
26
|
+
import { sharedConfig } from '@ampernic/vitepress-theme-alt-docs/config'
|
|
27
|
+
|
|
28
|
+
export default defineConfig({
|
|
29
|
+
...sharedConfig,
|
|
30
|
+
// ... специфичный для сайта конфиг
|
|
31
|
+
})
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Компоненты
|
|
35
|
+
|
|
36
|
+
| Компонент | Описание |
|
|
37
|
+
|-----------|----------|
|
|
38
|
+
| `ADBranding` | Логотип и брендинг ALT Linux в навбаре |
|
|
39
|
+
| `ADProducts` | Переключатель продуктов/дистрибутивов |
|
|
40
|
+
| `ADProductsSidebar` | Боковая панель с выбором продукта |
|
|
41
|
+
| `ADVersioning` | Переключатель версий документации |
|
|
42
|
+
| `ADNavBarSearch` | Интеграция поиска в навбар |
|
|
43
|
+
| `ADSearch` | Компонент поиска (Pagefind) |
|
|
44
|
+
| `ADAssetLink` | Ссылка на файл-ассет |
|
|
45
|
+
| `ADInlineImage` | Встроенное изображение с нормализацией пути |
|
|
46
|
+
|
|
47
|
+
## Включённые плагины
|
|
48
|
+
|
|
49
|
+
Тема автоматически подключает:
|
|
50
|
+
- `@ampernic/vitepress-plugin-pagefind` — статический поиск
|
|
51
|
+
- `@ampernic/vitepress-plugin-cross-site-router` — межсайтовая навигация
|
|
52
|
+
- `@ampernic/vitepress-plugin-html-image` — нормализация `<img src>` в raw HTML
|
|
53
|
+
- `@ampernic/vitepress-plugin-alt-docs-versioning` — версионирование
|
|
54
|
+
- `vitepress-plugin-tabs` — вкладки в Markdown
|
|
55
|
+
- `@nolebase/vitepress-plugin-enhanced-readabilities` — улучшенная читаемость
|
|
56
|
+
- `markdown-it-kbd` — синтаксис клавиш `[[Ctrl+C]]`
|
|
57
|
+
- `@alt-gnome/markdown-it-custom-containers` — кастомные контейнеры
|
|
58
|
+
|
|
59
|
+
## Лицензия
|
|
60
|
+
|
|
61
|
+
GPL-3.0-or-later
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ampernic/vitepress-theme-alt-docs",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.3",
|
|
4
4
|
"description": "Shared VitePress theme for ALT Linux documentation",
|
|
5
5
|
"license": "GPL-3.0-or-later",
|
|
6
6
|
"author": "Ampernic",
|
|
@@ -33,10 +33,10 @@
|
|
|
33
33
|
"@nolebase/vitepress-plugin-enhanced-readabilities": "^2.14.0",
|
|
34
34
|
"markdown-it-kbd": "^1.0.0",
|
|
35
35
|
"vitepress-plugin-tabs": "^0.6.0",
|
|
36
|
-
"@ampernic/vitepress-plugin-
|
|
37
|
-
"@ampernic/vitepress-plugin-
|
|
38
|
-
"@ampernic/vitepress-plugin-
|
|
39
|
-
"@ampernic/vitepress-plugin-
|
|
36
|
+
"@ampernic/vitepress-plugin-pagefind": "0.1.2",
|
|
37
|
+
"@ampernic/vitepress-plugin-alt-docs-versioning": "0.1.2",
|
|
38
|
+
"@ampernic/vitepress-plugin-cross-site-router": "0.1.2",
|
|
39
|
+
"@ampernic/vitepress-plugin-html-image": "0.1.2"
|
|
40
40
|
},
|
|
41
41
|
"devDependencies": {
|
|
42
42
|
"builtin-modules": "^3.3.0",
|
|
@@ -44,8 +44,7 @@
|
|
|
44
44
|
"vue-tsc": "^2.0.0"
|
|
45
45
|
},
|
|
46
46
|
"publishConfig": {
|
|
47
|
-
"access": "public"
|
|
48
|
-
"registry": "https://registry.npmjs.org/"
|
|
47
|
+
"access": "public"
|
|
49
48
|
},
|
|
50
49
|
"scripts": {
|
|
51
50
|
"build": "unbuild",
|