Skip to content

Commit

Permalink
nodemodules: migration vitepress-plugin-enhanced-readabilities
Browse files Browse the repository at this point in the history
.vitepress: fix typeJS
  • Loading branch information
OlegShchavelev committed Jul 11, 2024
1 parent 5bb53dd commit 323df25
Show file tree
Hide file tree
Showing 9 changed files with 193 additions and 57 deletions.
2 changes: 1 addition & 1 deletion .vitepress/config/en.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { defineConfigWithTheme, type DefaultTheme } from 'vitepress'
import { defineConfigWithTheme} from 'vitepress'
import { nav, sidebar } from '../data/navigations'
import { packages } from '../../package-lock.json'

Expand Down
2 changes: 1 addition & 1 deletion .vitepress/config/ru.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { defineConfigWithTheme, type DefaultTheme } from 'vitepress'
import { defineConfigWithTheme } from 'vitepress'
import { nav, sidebar } from '../data/navigations'
import { packages } from '../../package-lock.json'

Expand Down
77 changes: 40 additions & 37 deletions .vitepress/config/shared.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,41 +3,44 @@ import markdownTimeline from "vitepress-markdown-timeline"
import { tabsMarkdownPlugin } from 'vitepress-plugin-tabs'

export const shared = defineConfigWithTheme({
title: "ALT Mobile Wiki",
titleTemplate: ':title — ALT Mobile Wiki',
base: '/ALTMobileWiki/',
srcDir: './docs',
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' }
],
editLink: {
pattern: 'https://github.com/OlegShchavelev/ALTMobileWiki/tree/main/docs/:path',
},
outline: {
level: [2, 3],
},
},
markdown: {
container: {
tipLabel: 'TIPS',
warningLabel: 'WARNING',
dangerLabel: 'CAUTION',
infoLabel: 'NOTE',
detailsLabel: 'DETAILS'
},
config: (md) => {
md.use(markdownTimeline);
md.use(tabsMarkdownPlugin)
},
},
title: "ALT Mobile Wiki",
titleTemplate: ':title — ALT Mobile Wiki',
base: '/ALTMobileWiki/',
srcDir: './docs',
vite: {
optimizeDeps: {
exclude: ['@nolebase/vitepress-plugin-enhanced-readabilities/client']
},
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' }
],
editLink: {
pattern: 'https://github.com/OlegShchavelev/ALTMobileWiki/tree/main/docs/:path',
},
outline: {
level: [2, 3],
},
},
markdown: {
container: {
tipLabel: 'TIPS',
warningLabel: 'WARNING',
dangerLabel: 'CAUTION',
infoLabel: 'NOTE',
detailsLabel: 'DETAILS'
},
config: (md) => {
md.use(markdownTimeline);
md.use(tabsMarkdownPlugin)
},
},
})
78 changes: 78 additions & 0 deletions .vitepress/data/lexicon.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
export const ERlocales = {
'ru-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:
'Добавьте фиксированную линию сплошным цветом в сторону элемента наведения курсора, чтобы выделить место, где в данный момент находится курсор'
}
}
}
}
2 changes: 1 addition & 1 deletion .vitepress/theme/components/AMWHomeSponsors.vue
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
import { VPHomeSponsors } from 'vitepress/theme'
import { sponsors } from '../../data/sponsors'
const { message, data } = defineProps({
const { message } = defineProps({
message: {
type: String,
default:
Expand Down
20 changes: 10 additions & 10 deletions .vitepress/theme/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@ import AMWDocsAsideMeta from './components/AMWDocsAsideMeta.vue'
import AMWHomeSponsors from './components/AMWHomeSponsors.vue'
import AMWVideo from './components/AMWVideo.vue'

import {
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'
} from '@nolebase/vitepress-plugin-enhanced-readabilities/client'
import type { Options } from '@nolebase/vitepress-plugin-enhanced-readabilities/client'
import { NolebaseEnhancedReadabilitiesPlugin } from '@nolebase/vitepress-plugin-enhanced-readabilities/client'
import '@nolebase/vitepress-plugin-enhanced-readabilities/client/style.css'
import { enhanceAppWithTabs } from 'vitepress-plugin-tabs/client'

import './styles/style.css'
import './styles/style.css'
import './styles/theme.css'
import '@nolebase/vitepress-plugin-enhanced-readabilities/dist/style.css'
import '@nolebase/vitepress-plugin-enhanced-readabilities/client/style.css'
import "vitepress-markdown-timeline/dist/theme/index.css"
import { ERlocales } from '../data/lexicon'

export default {
extends: DefaultTheme,
Expand All @@ -33,8 +33,8 @@ export default {
'home-features-after': () => h(AMWHomeSponsors)
})
},
enhanceApp({ app, router, siteData }) {
app.provide(InjectionKey, NolebaseEnhancedReadabilitiesOptions as Options)
enhanceApp({ app }) {
app.use(NolebaseEnhancedReadabilitiesPlugin, {locales: ERlocales} as Options)
app.component('contribution', AMWContribution)
app.component('Video', AMWVideo)
enhanceAppWithTabs(app)
Expand Down
34 changes: 28 additions & 6 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"devDependencies": {
"@nolebase/vitepress-plugin-enhanced-readabilities": "^1.27.2",
"@nolebase/vitepress-plugin-enhanced-readabilities": "^2.2.2",
"@nolebase/vitepress-plugin-git-changelog": "^2.2.0",
"vitepress": "^1.0.2",
"vitepress-markdown-timeline": "^1.2.1",
Expand Down
33 changes: 33 additions & 0 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"compilerOptions": {
"jsx": "preserve",
"lib": [
"DOM",
"ESNext"
],
"module": "ESNext",
"moduleResolution": "Bundler",
"resolveJsonModule": true,
"strict": true,
"strictNullChecks": true,
"noFallthroughCasesInSwitch": true,
"noImplicitAny": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"noEmit": true,
"removeComments": false,
"esModuleInterop": true,
"forceConsistentCasingInFileNames": true,
"isolatedModules": true,
"verbatimModuleSyntax": true,
"skipLibCheck": true
},
"include": [
"**/.vitepress/**/*.ts",
"**/.vitepress/**/*.mts",
"**/.vitepress/**/*.vue"
],
"exclude": [
"node_modules"
]
}

0 comments on commit 323df25

Please sign in to comment.