Skip to content

Commit

Permalink
Initial project ALT Mobile Wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
OlegShchavelev committed Apr 2, 2024
1 parent e9def66 commit cb8c9a2
Show file tree
Hide file tree
Showing 37 changed files with 2,431 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
.vitepress/dist
.vitepress/cache
69 changes: 69 additions & 0 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
import { defineConfig } from 'vitepress'
import { nav, sidebar } from './data/navigations'

// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "ALT Mobile Wiki",
titleTemplate: ':title — ALT Mobile Wiki',
description: "официальная библиотека знаний операционной системы ALT Mobile",
base: '/ALTMobileWiki/',
srcDir: './docs',
locales: {
root: {
label: 'Русский',
lang: 'ru',
themeConfig: {
nav: nav.root,
sidebar: sidebar.root,
docFooter: {
prev: 'Предыдущая страница',
next: 'Следующая страница'
},
editLink: {
pattern: 'https://github.com/OlegShchavelev/ALTRegularGnomeWiki/edit/main/docs/:path',
text: 'Предложить изменения на этой странице'
},
lastUpdated: {
text: 'Последнее обновление',
formatOptions: {
dateStyle: 'medium',
timeStyle: 'medium'
}
},
returnToTopLabel: 'Наверх',
sidebarMenuLabel: 'Меню',
outlineTitle: 'Оглавление',
notFound: {
title: 'Страница не найдена',
quote: 'Похоже, что вы перешли по неверной или устаревшей ссылке. Вы можете воспользоваться поиском.',
linkText: 'Вернуться на главную'
}
},
},
en: {
label: 'Английский',
lang: 'en',
themeConfig: {
nav: nav.en,
sidebar: sidebar.en
}
}
},
vite: {
ssr: {
noExternal: [
'@nolebase/vitepress-plugin-enhanced-readabilities',
],
},
},
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
logo: { src: '/logo.svg', width: 36, height: 36, alt: "ALT Mobile Wike" },
socialLinks: [
{ icon: 'github', link: 'https://github.com/OlegShchavelev/ALTMobileWiki' }
],
outline: {
level: [2, 3],
},
}
})
10 changes: 10 additions & 0 deletions .vitepress/data/contributions.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
export const contributions = [
{
avatar: 'https://avatars.githubusercontent.com/u/20732384?v=4',
name: 'Олег Щавелев',
title: 'Разработчик',
links: [
{ icon: 'github', link: 'https://github.com/OlegShchavelev' }
]
},
]
65 changes: 65 additions & 0 deletions .vitepress/data/navigations.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
export const nav = {
'root': [
{ text: 'Главная', link: '/' },
{ text: 'Документация', link: '/wiki/' },
{
text: 'О проекте', items: [
{ text: 'О проекте', link: '/projects/about/' },
{ text: 'Участники', link: '/projects/contributions/' }
]
},
],
'en': [
{ text: 'Home', link: '/en/' },
{ text: 'Documentation', link: '/en/wiki/' },
{
text: 'About project', items: [
{ text: 'About project', link: '/en/projects/about/' },
{ text: 'Contributions', link: '/en/projects/contributions/' }
]
},
]
}

export const sidebar = {
'root': [
{
items: [
{
text: 'Установка и обновление', base: '/instalations', items: [
{ text: 'Загрузчик', link: '/booting/' },
{ text: 'ALT Mobile', link: '/alt-mobile/' }
],
collapsed: true
}, {
text: 'Програмное обеспечение', base: '/apps', items: [
{ text: 'Amberol', link: '/amberol/' }
],
collapsed: true
}, {
text: 'Популярные вопросы и ответы', link: '/faq/'
}]
}
],
'en': [
{
base: '/en',
items: [
{
text: 'Installation and update', base: '/en/instalations', items: [
{ text: 'The loader', link: '/booting/' },
{ text: 'ALT Mobile', link: '/alt-mobile/' }
],
collapsed: true
}, {
text: 'Software', base: '/en/apps', items: [
{ text: 'Amberol', link: '/amberol/' }
],
collapsed: true
}, {
text: 'Frequently asked questions', link: '/faq/'
}
]
}
],
}
38 changes: 38 additions & 0 deletions .vitepress/theme/components /AMWTeamMembers.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<template>
<VPTeamPage>
<VPTeamPageTitle>
<template v-if="frontmatter.title" #title>
{{ frontmatter.title }}
</template>
</VPTeamPageTitle>
<VPTeamMembers :members="members" />
</VPTeamPage>
</template>

<script setup>
import { contributions } from '../../data/contributions';
import { VPTeamPage, VPTeamPageTitle, VPTeamMembers } from 'vitepress/theme';
import { useData } from 'vitepress'
const { frontmatter } = useData();
const { members, size } = defineProps({
size: {
type: String,
default: 'medium',
},
members: {
type: Object,
default: () => {
return contributions ?? [];
},
},
});
</script>
<style scoped>
.VPTeamPage {
margin: 0;
}
</style>
33 changes: 33 additions & 0 deletions .vitepress/theme/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
// https://vitepress.dev/guide/custom-theme
import { h } from 'vue'
import type { Theme } from 'vitepress'
import DefaultTheme from 'vitepress/theme'

import AMWTeamMembers from './components /AMWTeamMembers.vue'

import {
NolebaseEnhancedReadabilitiesMenu,
NolebaseEnhancedReadabilitiesScreenMenu
} from '@nolebase/vitepress-plugin-enhanced-readabilities'

import type { Options } from '@nolebase/vitepress-plugin-enhanced-readabilities'
import { InjectionKey } from '@nolebase/vitepress-plugin-enhanced-readabilities'
import { options as NolebaseEnhancedReadabilitiesOptions } from './plugins/enhanced-readabilities/index'

import './styles/style.css'
import './styles/theme.css'
import '@nolebase/vitepress-plugin-enhanced-readabilities/dist/style.css'

export default {
extends: DefaultTheme,
Layout: () => {
return h(DefaultTheme.Layout, null, {
'nav-bar-content-after': () => h(NolebaseEnhancedReadabilitiesMenu),
'nav-screen-content-after': () => h(NolebaseEnhancedReadabilitiesScreenMenu)
})
},
enhanceApp({ app, router, siteData }) {
app.provide(InjectionKey, NolebaseEnhancedReadabilitiesOptions as Options)
app.component('AMWTeamMembers', AMWTeamMembers);
}
} satisfies Theme
66 changes: 66 additions & 0 deletions .vitepress/theme/plugins/enhanced-readabilities/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
export const options = {
locales: {
'ru': {
title: {
title: 'Повышенная читаемость'
},
layoutSwitch: {
title: 'Измените внешний вид страницы',
titleHelpMessage: 'Измените стиль оформления ALT Gnome Wiki, выбирите максимально удобный вариант зависмости от размера вашего экрана и типа устройства.',
optionFullWidth: 'Полноэкранный',
optionFullWidthAriaLabel: 'Полноэкранный',
titleScreenNavWarningMessage: 'Изменить внешний вид страницы недоступен на экране мобильного устройства',
optionFullWidthHelpMessage: 'Боковая панель и область содержимого занимают всю ширину экрана.',
optionSidebarWidthAdjustableOnly: 'Боковая панель с пользовательской настройкой',
optionSidebarWidthAdjustableOnlyAriaLabel: 'Боковая панель с пользовательской настройкой',
optionSidebarWidthAdjustableOnlyHelpMessage: 'Увеличьте ширину боковой панели, максимальная ширина боковой панели может изменяться, но ширина области содержимого останется прежней.',
optionBothWidthAdjustable: 'Полноэрканный с пользовательской настройкой',
optionBothWidthAdjustableAriaLabel: 'Полноэрканный с пользовательской настройкой',
optionBothWidthAdjustableHelpMessage: 'Управляется шириной боковой панели, и шириной содержания документа. Настройте желаемую ширину максимальной ширины боковой панели и содержимого документа.',
optionOriginalWidth: 'Оригинальная ширина',
optionOriginalWidthAriaLabel: 'Оригинальная ширина',
optionOriginalWidthHelpMessage: 'Оригинальная ширина размера страницы, предусмотренная разработчиками VitePress',
pageLayoutMaxWidth: {
title: 'Измените максимальную ширину страницы',
titleAriaLabel: 'Измените максимальную ширину страницы',
titleHelpMessage: 'Отрегулируйте точное значение ширины страницы ALT Gnome Wiki, чтобы адаптироваться к различным потребностям чтения и экранам.',
titleScreenNavWarningMessage: 'Максимальная ширина макета страницы недоступна на экране мобильного устройства.',
slider: 'Отрегулируйте максимальную ширину страницы',
sliderAriaLabel: 'Отрегулируйте максимальную ширину страницы',
sliderHelpMessage: 'Расположенный ползунок, позволяющий пользователю выбирать и настраивать желаемую ширину страницы, может быть изменен в зависимости от размера вашего экрана.',
},
contentLayoutMaxWidth: {
title: 'Измените максимальную ширину содержания',
titleAriaLabel: 'Измените максимальную ширину содержания',
titleHelpMessage: 'Отрегулируйте точное значение ширины содержимого документа в макете ALT Gnome Wiki, чтобы адаптироваться к различным потребностям чтения и экранам.',
titleScreenNavWarningMessage: 'Максимальная ширина макета содержимого недоступна на экране мобильного устройства.',
slider: 'Отрегулируйте максимальную ширину содержимого',
sliderAriaLabel: 'Отрегулируйте максимальную ширину содержимого',
sliderHelpMessage: 'Расположенный ползунок, позволит пользователю выбирать и настраить желаемую ширину содержимого, может быть изменен в зависимости от размера вашего экрана.',
}
},
spotlight: {
title: 'Фокус',
titleAriaLabel: 'Фокус',
titleHelpMessage: 'Выделите строку, на которой в данный момент находится курсор мыши, в содержимом, для удобства пользователей, у которых могут возникнуть трудности с чтением и фокусировкой.',
titleScreenNavWarningMessage: 'Фокус недоступен на экране мобильного устройства.',
optionOn: 'Включить',
optionOnAriaLabel: 'Включить',
optionOnHelpMessage: 'Включите фокус.',
optionOff: 'Выключить',
optionOffAriaLabel: 'Выключить',
optionOffHelpMessage: 'Выключите фокус.',
styles: {
title: 'Стиль фокуса',
titleHelpMessage: 'Измените стиль фокуса(подсветки)',
optionUnder: 'Under',
optionUnderAriaLabel: 'Under',
optionUnderHelpMessage: 'Добавьте сплошной цвет фона под зависающим элементом, чтобы выделить место, где в данный момент находится курсор',
optionAside: 'Aside',
optionAsideAriaLabel: 'Aside',
optionAsideHelpMessage: 'Добавьте фиксированную линию сплошным цветом в сторону элемента наведения курсора, чтобы выделить место, где в данный момент находится курсор'
}
}
}
}
}
Loading

0 comments on commit cb8c9a2

Please sign in to comment.