> = Symbol('vitepress-nolebase-page-properties')
5 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-page-properties/src/client/index.ts:
--------------------------------------------------------------------------------
1 | import type { Plugin } from 'vue'
2 |
3 | import type {
4 | DatetimeProperty,
5 | DynamicProperty,
6 | DynamicPropertyType,
7 | DynamicReadingTimeProperty,
8 | DynamicWordsCountProperty,
9 | LinkProperty,
10 | Locale,
11 | LocaleName,
12 | Options,
13 | PlainProperty,
14 | ProgressProperty,
15 | Property,
16 | PropertyType,
17 | TagsProperty,
18 | } from './types'
19 | import NolebasePageProperties from './components/PageProperties.vue'
20 | import NolebasePagePropertiesEditor from './components/PagePropertiesEditor.vue'
21 | import { InjectionKey } from './constants'
22 |
23 | const components = {
24 | NolebasePageProperties,
25 | NolebasePagePropertiesEditor,
26 | }
27 |
28 | export function NolebasePagePropertiesPlugin(): Plugin[]> {
29 | return {
30 | install(app, options?) {
31 | if (typeof options !== 'undefined' && typeof options === 'object')
32 | app.provide(InjectionKey, options)
33 |
34 | for (const key of Object.keys(components))
35 | app.component(key, components[key as keyof typeof components])
36 | },
37 | }
38 | }
39 |
40 | export {
41 | InjectionKey,
42 | NolebasePageProperties,
43 | NolebasePagePropertiesEditor,
44 | }
45 |
46 | export type {
47 | DatetimeProperty,
48 | DynamicProperty,
49 | DynamicPropertyType,
50 | DynamicReadingTimeProperty,
51 | DynamicWordsCountProperty,
52 | LinkProperty,
53 | Locale,
54 | LocaleName,
55 | Options,
56 | PlainProperty,
57 | ProgressProperty,
58 | Property,
59 | PropertyType,
60 | TagsProperty,
61 | }
62 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-page-properties/src/client/locales.ts:
--------------------------------------------------------------------------------
1 | import type { Locale } from './types'
2 | import { defaultEnLocale, defaultZhCNLocale } from '../locales'
3 |
4 | export {
5 | defaultEnLocale,
6 | defaultZhCNLocale,
7 | }
8 |
9 | export const defaultLocales: Record = {
10 | 'zh-CN': defaultZhCNLocale,
11 | 'zh-Hans': defaultZhCNLocale,
12 | 'zh': defaultZhCNLocale,
13 | 'en-US': defaultEnLocale,
14 | 'en': defaultEnLocale,
15 | }
16 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-page-properties/src/client/style.css:
--------------------------------------------------------------------------------
1 | @import "@nolebase/ui/style.css";
2 | @import "./unocss.css";
3 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-page-properties/src/client/utils.ts:
--------------------------------------------------------------------------------
1 | import type { LocaleName } from './types'
2 | import { formatDistanceToNow, formatDuration, toDate } from 'date-fns'
3 |
4 | import * as DateFnsLocales from 'date-fns/locale'
5 |
6 | export function formatDistanceToNowFromValue(value: string | number | Date, localeName: LocaleName = 'enUS') {
7 | try {
8 | return formatDistanceToNow(toDate(value), {
9 | locale: DateFnsLocales[localeName] || 'enUS',
10 | addSuffix: true,
11 | })
12 | }
13 | catch {
14 | return value
15 | }
16 | }
17 |
18 | export function formatDurationFromValue(value: number, localeName: LocaleName = 'enUS') {
19 | const parsedValue = Number.parseInt(String(value))
20 |
21 | try {
22 | return formatDuration({
23 | minutes: Number.isNaN(parsedValue) ? 0 : parsedValue,
24 | }, {
25 | locale: DateFnsLocales[localeName] || 'enUS',
26 | })
27 | }
28 | catch {
29 | return value
30 | }
31 | }
32 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-page-properties/src/client/virtual.d.ts:
--------------------------------------------------------------------------------
1 | interface TagsProperty {
2 | type: 'tags'
3 | key: K
4 | title: string
5 | omitEmpty?: boolean
6 | }
7 |
8 | interface PlainProperty {
9 | type: 'plain'
10 | key: K
11 | title: string
12 | omitEmpty?: boolean
13 | }
14 |
15 | interface DatetimeProperty {
16 | type: 'datetime'
17 | key: K
18 | title: string
19 | formatAsFrom?: boolean
20 | dateFnsLocaleName?: import('./types').LocaleName
21 | format?: string
22 | omitEmpty?: boolean
23 | }
24 |
25 | interface ProgressProperty {
26 | type: 'progress'
27 | key: K
28 | title: string
29 | omitEmpty?: boolean
30 | }
31 |
32 | interface LinkProperty {
33 | type: 'link'
34 | key: K
35 | title: string
36 | omitEmpty?: boolean
37 | }
38 |
39 | interface DynamicProperty {
40 | type: 'dynamic'
41 | key: K | string
42 | title: string
43 | options:
44 | DynamicWordsCountProperty |
45 | DynamicReadingTimeProperty
46 | }
47 |
48 | interface DynamicWordsCountProperty {
49 | type: 'wordsCount'
50 | }
51 |
52 | interface DynamicReadingTimeProperty {
53 | type: 'readingTime'
54 | dateFnsLocaleName?: import('./types').LocaleName
55 | }
56 |
57 | type Property =
58 | TagsProperty |
59 | PlainProperty |
60 | DatetimeProperty |
61 | ProgressProperty |
62 | LinkProperty |
63 | DynamicProperty
64 |
65 | type PropertyType = Property['type']
66 | type DynamicPropertyType = DynamicProperty['options']['type']
67 |
68 | declare module 'virtual:nolebase-page-properties' {
69 | const pagePropertiesData: Record
73 |
74 | export default pagePropertiesData
75 | }
76 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-page-properties/src/locales/en.yaml:
--------------------------------------------------------------------------------
1 | pageProperties:
2 | wordsCount: '{{wordsCount}} words'
3 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-page-properties/src/locales/index.ts:
--------------------------------------------------------------------------------
1 | import defaultEnLocale from './en.yaml'
2 | import defaultZhCNLocale from './zh-CN.yaml'
3 |
4 | export {
5 | defaultEnLocale,
6 | defaultZhCNLocale,
7 | }
8 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-page-properties/src/locales/zh-CN.yaml:
--------------------------------------------------------------------------------
1 | pageProperties:
2 | wordsCount: '{{wordsCount}} 字'
3 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-page-properties/src/vite/index.ts:
--------------------------------------------------------------------------------
1 | export * from './markdownSection'
2 | export * from './pageProperties'
3 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-page-properties/src/vite/pageProperties/types.ts:
--------------------------------------------------------------------------------
1 | export type PagePropertiesData = Record
5 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-page-properties/src/vite/path.ts:
--------------------------------------------------------------------------------
1 | import { normalizePath } from 'vite'
2 |
3 | export function pathEquals(path: string, equals: string): boolean {
4 | return normalizePath(path) === (normalizePath(equals))
5 | }
6 |
7 | export function pathStartsWith(path: string, startsWith: string): boolean {
8 | return normalizePath(path).startsWith(normalizePath(startsWith))
9 | }
10 |
11 | export function pathEndsWith(path: string, startsWith: string): boolean {
12 | return normalizePath(path).endsWith(normalizePath(startsWith))
13 | }
14 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-page-properties/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "../../tsconfig.json",
3 | "compilerOptions": {
4 | "types": [
5 | "node",
6 | "vite/client",
7 | "./src/client/virtual.d.ts",
8 | "./yaml.d.ts"
9 | ],
10 | "declaration": false,
11 | "noEmit": false
12 | },
13 | "include": [
14 | "./src/**/*.ts",
15 | "./src/**/*.mts",
16 | "./src/**/*.tsx",
17 | "./src/**/*.d.ts",
18 | "./src/**/*.vue"
19 | ],
20 | "exclude": [
21 | "**/dist/**",
22 | "node_modules"
23 | ]
24 | }
25 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-page-properties/yaml.d.ts:
--------------------------------------------------------------------------------
1 | declare module '*.yaml' {
2 | const value: Record | Array>
3 | export default value
4 | }
5 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-sidebar/README.md:
--------------------------------------------------------------------------------
1 | # `@nolebase/vitepress-plugin-sidebar`
2 |
3 | A vitepress plugin to generate sidebar for your site.
4 |
5 | ## Install
6 |
7 | ### Npm
8 |
9 | ```shell
10 | npm i @nolebase/vitepress-plugin-sidebar -D
11 | ```
12 |
13 | ### Yarn
14 |
15 | ```shell
16 | yarn add @nolebase/vitepress-plugin-sidebar -D
17 | ```
18 |
19 | ### Pnpm
20 |
21 | ```shell
22 | pnpm add @nolebase/vitepress-plugin-sidebar -D
23 | ```
24 |
25 | ## Documentation
26 |
27 | Please refer to [Sidebar](https://nolebase-integrations.ayaka.io/pages/en/integrations/vitepress-plugin-sidebar/) for more information.
28 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-sidebar/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@nolebase/vitepress-plugin-sidebar",
3 | "type": "module",
4 | "version": "2.17.1",
5 | "description": "A vitepress plugin to generate sidebar for your site.",
6 | "author": {
7 | "name": "Nólëbase",
8 | "email": "nolebase@ayaka.moe",
9 | "url": "https://github.com/nolebase"
10 | },
11 | "license": "MIT",
12 | "homepage": "https://nolebase-integrations.ayaka.io/pages/en/integrations/vitepress-plugin-sidebar/",
13 | "repository": {
14 | "type": "git",
15 | "url": "https://github.com/nolebase/integrations.git",
16 | "directory": "packages/vitepress-plugin-sidebar"
17 | },
18 | "keywords": [
19 | "vitepress",
20 | "nolebase",
21 | "markdown",
22 | "vitepress-plugin",
23 | "nolebase-integration",
24 | "sidebar"
25 | ],
26 | "sideEffects": [
27 | "**/*.css"
28 | ],
29 | "exports": {
30 | ".": {
31 | "types": "./dist/index.d.ts",
32 | "import": "./dist/index.mjs",
33 | "require": "./dist/index.cjs"
34 | }
35 | },
36 | "main": "./dist/index.cjs",
37 | "module": "./dist/index.mjs",
38 | "types": "./dist/index.d.ts",
39 | "files": [
40 | "README.md",
41 | "dist",
42 | "package.json"
43 | ],
44 | "scripts": {
45 | "dev": "concurrently \"pnpm run stub\"",
46 | "stub": "unbuild --stub",
47 | "build": "unbuild",
48 | "typecheck": "tsc --noEmit"
49 | },
50 | "peerDependencies": {
51 | "vitepress": "^1.5.0 || ^2.0.0-alpha.1"
52 | },
53 | "dependencies": {
54 | "fs-extra": "^11.3.0",
55 | "gray-matter": "^4.0.3",
56 | "tinyglobby": "^0.2.14"
57 | },
58 | "devDependencies": {
59 | "@types/fs-extra": "^11.0.4"
60 | }
61 | }
62 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-sidebar/src/index.ts:
--------------------------------------------------------------------------------
1 | export {
2 | calculateSidebar,
3 | } from './sidebar'
4 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-sidebar/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "../../tsconfig.json",
3 | "compilerOptions": {
4 | "declaration": true,
5 | "noEmit": false,
6 | "outDir": "./dist"
7 | },
8 | "include": [
9 | "./src/**/*.ts",
10 | "./src/**/*.mts",
11 | "./src/**/*.tsx",
12 | "./src/**/*.d.ts",
13 | "./src/**/*.vue"
14 | ],
15 | "exclude": [
16 | "**/dist/**",
17 | "node_modules"
18 | ]
19 | }
20 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-thumbnail-hash/README.md:
--------------------------------------------------------------------------------
1 | # `@nolebase/vitepress-plugin-thumbnail-hash`
2 |
3 | A VitePress plugin that scan and generate data with [blurhash](https://github.com/woltapp/blurhash), [thumbhash](https://github.com/evanw/thumbhash) hashing algorithm for images, as well as a standalone component to render images with [blurhash](https://github.com/woltapp/blurhash) and [thumbhash](https://github.com/evanw/thumbhash).
4 |
5 | ## Install
6 |
7 | ### Npm
8 |
9 | ```shell
10 | npm i @nolebase/vitepress-plugin-thumbnail-hash -D
11 | ```
12 |
13 | ### Yarn
14 |
15 | ```shell
16 | yarn add @nolebase/vitepress-plugin-thumbnail-hash -D
17 | ```
18 |
19 | ### Pnpm
20 |
21 | ```shell
22 | pnpm add @nolebase/vitepress-plugin-thumbnail-hash -D
23 | ```
24 |
25 | ## Documentation
26 |
27 | Please refer to [Thumbnail hashing for images](https://nolebase-integrations.ayaka.io/pages/en/integrations/vitepress-plugin-thumbnail-hash/) for more information.
28 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-thumbnail-hash/build.config.ts:
--------------------------------------------------------------------------------
1 | import { exec } from 'node:child_process'
2 | import { promisify } from 'node:util'
3 |
4 | import builtins from 'builtin-modules'
5 | import { defineBuildConfig } from 'unbuild'
6 |
7 | const execAsync = promisify(exec)
8 |
9 | export default defineBuildConfig({
10 | entries: [
11 | { builder: 'mkdist', input: './src/client', outDir: './dist/client', pattern: ['**/*.vue'], loaders: ['vue'] },
12 | { builder: 'mkdist', input: './src/client', outDir: './dist/client', pattern: ['**/*.ts'], format: 'cjs', loaders: ['js'] },
13 | { builder: 'mkdist', input: './src/client', outDir: './dist/client', pattern: ['**/*.ts'], format: 'esm', loaders: ['js'] },
14 | { builder: 'mkdist', input: './src/client', outDir: './dist/client', pattern: ['**/*.css'], loaders: ['postcss'] },
15 | { builder: 'rollup', input: './src/vite/index', outDir: './dist/vite' },
16 | ],
17 | clean: true,
18 | sourcemap: true,
19 | declaration: true,
20 | externals: [
21 | 'vite',
22 | 'canvaskit-wasm',
23 | 'colorette',
24 | 'uncrypto',
25 | 'unlazy',
26 | 'vitepress',
27 | // builtins
28 | ...builtins,
29 | ],
30 | rollup: {
31 | emitCJS: true,
32 | },
33 | hooks: {
34 | 'mkdist:done': async (ctx) => {
35 | if (ctx.options.stub)
36 | return
37 | // Since not all the users would choose to use unocss,
38 | // we bundle the styles from unocss here for users to opt-in.
39 | //
40 | // However, since the unocss doesn't provide a unplugin, or rollup
41 | // plugin for us to use, we have to use the CLI here.
42 | //
43 | // The use of CLI was suggested by how to use unocss with rollup? · unocss/unocss · Discussion #542
44 | // https:// github.com/unocss/unocss/discussions/542
45 | await execAsync('unocss "./src/client/**/*.vue" -o dist/client/unocss.css')
46 | },
47 | },
48 | })
49 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-thumbnail-hash/src/client/components/NolebaseUnlazyImg.vue:
--------------------------------------------------------------------------------
1 |
23 |
24 |
25 |
26 | ![]()
36 |
37 |
49 |
50 |
51 |
56 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-thumbnail-hash/src/client/index.ts:
--------------------------------------------------------------------------------
1 | export { default as NolebaseUnlazyImg } from './components/NolebaseUnlazyImg.vue'
2 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-thumbnail-hash/src/client/style.css:
--------------------------------------------------------------------------------
1 | @import "./unocss.css"
2 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-thumbnail-hash/src/types/index.ts:
--------------------------------------------------------------------------------
1 | export interface ThumbHashAsset {
2 | /**
3 | * The file name of the image. Will be normalized to be relative to the
4 | * root of the VitePress configuration file.
5 | */
6 | assetFileName: string
7 | /**
8 | * The full file name of the image.
9 | */
10 | assetFullFileName: string
11 | /**
12 | * The hash of the image.
13 | */
14 | assetFullHash: string
15 | /**
16 | * The base64 encoded url safe hash of the image.
17 | */
18 | assetFileHash: string
19 | /**
20 | * The asset URL of the image. Will be used to render as `src` attribute
21 | * in the HTML.
22 | */
23 | assetUrl: string
24 | /**
25 | * The asset URL of the image with base. Will be used to render as `data-src`
26 | * attribute in the HTML used by unlazy.
27 | *
28 | * Value will be automatically calculated based on the `base` field
29 | * configured in the VitePress configuration.
30 | */
31 | assetUrlWithBase: string
32 | }
33 |
34 | export interface ThumbHashCalculated {
35 | /**
36 | * The thumbhash data URL of the image. Will be used to render as
37 | * `src` attribute in the HTML.
38 | */
39 | dataUrl: string
40 | /**
41 | * The thumbhash data base64 of the image. Will be used to render as
42 | * `data-thumbhash` attribute in the HTML.
43 | */
44 | dataBase64: string
45 | /**
46 | * The resized width of the image (thumbhash requires the image to be
47 | * resized to less than 100px in width or height).
48 | */
49 | width: number
50 | /**
51 | * The original width of the image.
52 | */
53 | originalWidth: number
54 | /**
55 | * The resized height of the image (thumbhash requires the image to
56 | * be resized to less than 100px in width or height).
57 | */
58 | height: number
59 | /**
60 | * The original height of the image.
61 | */
62 | originalHeight: number
63 | }
64 |
65 | export type ThumbHash = ThumbHashAsset & ThumbHashCalculated
66 |
--------------------------------------------------------------------------------
/packages/vitepress-plugin-thumbnail-hash/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "../../tsconfig.json",
3 | "compilerOptions": {
4 | "declaration": true,
5 | "noEmit": false,
6 | "outDir": "./dist"
7 | },
8 | "include": [
9 | "./src/**/*.ts",
10 | "./src/**/*.mts",
11 | "./src/**/*.tsx",
12 | "./src/**/*.d.ts",
13 | "./src/**/*.vue"
14 | ],
15 | "exclude": [
16 | "**/dist/**",
17 | "node_modules"
18 | ]
19 | }
20 |
--------------------------------------------------------------------------------
/pnpm-workspace.yaml:
--------------------------------------------------------------------------------
1 | packages:
2 | - packages/**
3 | - '!**/dist/**'
4 | - docs
5 | catalog:
6 | vite: ^6.3.5
7 | vue: ^3.5.14
8 |
--------------------------------------------------------------------------------
/uno.config.ts:
--------------------------------------------------------------------------------
1 | import {
2 | defineConfig,
3 | presetAttributify,
4 | presetIcons,
5 | presetUno,
6 | presetWebFonts,
7 | } from 'unocss'
8 |
9 | export default defineConfig({
10 | shortcuts: [],
11 | presets: [
12 | presetUno({
13 | dark: 'class',
14 | }),
15 | presetAttributify(),
16 | presetIcons({
17 | prefix: 'i-',
18 | scale: 1.2, // size: 1.2 rem
19 | extraProperties: {
20 | 'display': 'inline-block',
21 | 'vertical-align': 'middle',
22 | 'min-width': '1.2rem',
23 | },
24 | }),
25 | presetWebFonts({
26 | fonts: {
27 | 'chakra-petch': ['Chakra Petch'],
28 | 'baloo-2': [
29 | {
30 | name: 'Baloo 2',
31 | },
32 | {
33 | name: 'Noto Sans',
34 | },
35 | {
36 | name: 'Roboto',
37 | },
38 | {
39 | name: 'sans-serif',
40 | provider: 'none',
41 | },
42 | ],
43 | 'jura': ['Jura'],
44 | },
45 | }),
46 | ],
47 | })
48 |
--------------------------------------------------------------------------------
/vitest.workspace.ts:
--------------------------------------------------------------------------------
1 | import { defineWorkspace } from 'vitest/config'
2 |
3 | export default defineWorkspace([
4 | 'packages/*',
5 | ])
6 |
--------------------------------------------------------------------------------