msb-public
/
vitepress
mirror of https://github.com/vuejs/vitepress
2
1
Code Issues Projects Releases Wiki Activity

fix: simplify lang extraction logic; use markdown-it plugins in type-safe manner; bump deps

Browse Source
pull/2913/merge
Divyansh Singh 10 months ago
parent eddf0ca257
commit 4e548f5424
10 changed files with 1340 additions and 1311 deletions
Show Stats Download Patch File Download Diff File

4
docs/package.json
Unescape View File

@ -15,7 +15,7 @@
"open-cli": "^8.0.0", "open-cli": "^8.0.0",
"postcss-rtlcss": "^5.7.1", "postcss-rtlcss": "^5.7.1",
"vitepress": "workspace:*", "vitepress": "workspace:*",
"vitepress-plugin-group-icons": "^1.6.3", "vitepress-plugin-group-icons": "^1.6.5",
"vitepress-plugin-llms": "^1.7.3" "vitepress-plugin-llms": "^1.9.1"
} }
} }

88
package.json
Unescape View File

@ -95,28 +95,28 @@
"*": "prettier --experimental-cli --ignore-unknown --write" "*": "prettier --experimental-cli --ignore-unknown --write"
}, },
"dependencies": { "dependencies": {
"@docsearch/css": "^4.0.0-beta.8", "@docsearch/css": "^4.3.2",
"@docsearch/js": "^4.0.0-beta.8", "@docsearch/js": "^4.3.2",
"@iconify-json/simple-icons": "^1.2.49", "@iconify-json/simple-icons": "^1.2.58",
"@shikijs/core": "^3.12.0", "@shikijs/core": "^3.15.0",
"@shikijs/transformers": "^3.12.0", "@shikijs/transformers": "^3.15.0",
"@shikijs/types": "^3.12.0", "@shikijs/types": "^3.15.0",
"@types/markdown-it": "^14.1.2", "@types/markdown-it": "^14.1.2",
"@vitejs/plugin-vue": "^6.0.1", "@vitejs/plugin-vue": "^6.0.1",
"@vue/devtools-api": "^8.0.1", "@vue/devtools-api": "^8.0.3",
"@vue/shared": "^3.5.20", "@vue/shared": "^3.5.24",
"@vueuse/core": "^13.8.0", "@vueuse/core": "^14.0.0",
"@vueuse/integrations": "^13.8.0", "@vueuse/integrations": "^14.0.0",
"focus-trap": "^7.6.5", "focus-trap": "^7.6.6",
"mark.js": "8.11.1", "mark.js": "8.11.1",
"minisearch": "^7.1.2", "minisearch": "^7.2.0",
"shiki": "^3.12.0", "shiki": "^3.15.0",
"vite": "^7.1.3", "vite": "^7.2.2",
"vue": "^3.5.20" "vue": "^3.5.24"
}, },
"devDependencies": { "devDependencies": {
"@clack/prompts": "^1.0.0-alpha.4", "@clack/prompts": "^1.0.0-alpha.6",
"@iconify/utils": "^3.0.1", "@iconify/utils": "^3.0.2",
"@mdit-vue/plugin-component": "^3.0.2", "@mdit-vue/plugin-component": "^3.0.2",
"@mdit-vue/plugin-frontmatter": "^3.0.2", "@mdit-vue/plugin-frontmatter": "^3.0.2",
"@mdit-vue/plugin-headers": "^3.0.2", "@mdit-vue/plugin-headers": "^3.0.2",
@ -125,11 +125,11 @@
"@mdit-vue/plugin-toc": "^3.0.2", "@mdit-vue/plugin-toc": "^3.0.2",
"@mdit-vue/shared": "^3.0.2", "@mdit-vue/shared": "^3.0.2",
"@polka/compression": "^1.0.0-next.28", "@polka/compression": "^1.0.0-next.28",
"@rollup/plugin-alias": "^5.1.1", "@rollup/plugin-alias": "^6.0.0",
"@rollup/plugin-commonjs": "^28.0.6", "@rollup/plugin-commonjs": "^29.0.0",
"@rollup/plugin-json": "^6.1.0", "@rollup/plugin-json": "^6.1.0",
"@rollup/plugin-node-resolve": "^16.0.1", "@rollup/plugin-node-resolve": "^16.0.3",
"@rollup/plugin-replace": "^6.0.2", "@rollup/plugin-replace": "^6.0.3",
"@types/cross-spawn": "^6.0.6", "@types/cross-spawn": "^6.0.6",
"@types/debug": "^4.1.12", "@types/debug": "^4.1.12",
"@types/fs-extra": "^11.0.4", "@types/fs-extra": "^11.0.4",
@ -139,62 +139,62 @@
"@types/markdown-it-container": "^2.0.10", "@types/markdown-it-container": "^2.0.10",
"@types/markdown-it-emoji": "^3.0.1", "@types/markdown-it-emoji": "^3.0.1",
"@types/minimist": "^1.2.5", "@types/minimist": "^1.2.5",
"@types/node": "^24.3.0", "@types/node": "^24.10.1",
"@types/picomatch": "^4.0.2", "@types/picomatch": "^4.0.2",
"@types/prompts": "^2.4.9", "@types/prompts": "^2.4.9",
"chokidar": "^4.0.3", "chokidar": "^4.0.3",
"conventional-changelog-cli": "^5.0.0", "conventional-changelog-cli": "^5.0.0",
"cross-spawn": "^7.0.6", "cross-spawn": "^7.0.6",
"debug": "^4.4.1", "debug": "^4.4.3",
"esbuild": "^0.25.9", "esbuild": "^0.25.0",
"execa": "^9.6.0", "execa": "^9.6.0",
"fs-extra": "^11.3.1", "fs-extra": "^11.3.2",
"get-port": "^7.1.0", "get-port": "^7.1.0",
"gray-matter": "^4.0.3", "gray-matter": "^4.0.3",
"lint-staged": "^16.1.5", "lint-staged": "^16.2.6",
"lodash.template": "^4.5.0", "lodash.template": "^4.5.0",
"lru-cache": "^11.1.0", "lru-cache": "^11.2.2",
"markdown-it": "^14.1.0", "markdown-it": "^14.1.0",
"markdown-it-anchor": "^9.2.0", "markdown-it-anchor": "^9.2.0",
"markdown-it-async": "^2.2.0", "markdown-it-async": "^2.2.0",
"markdown-it-attrs": "^4.3.1", "markdown-it-attrs": "^4.3.1",
"markdown-it-cjk-friendly": "^1.2.0", "markdown-it-cjk-friendly": "^1.3.2",
"markdown-it-container": "^4.0.0", "markdown-it-container": "^4.0.0",
"markdown-it-emoji": "^3.0.0", "markdown-it-emoji": "^3.0.0",
"markdown-it-mathjax3": "^4.3.2", "markdown-it-mathjax3": "^4.3.2",
"minimist": "^1.2.8", "minimist": "^1.2.8",
"nanoid": "^5.1.5", "nanoid": "^5.1.6",
"ora": "^8.2.0", "ora": "^9.0.0",
"oxc-minify": "^0.82.3", "oxc-minify": "^0.97.0",
"p-map": "^7.0.3", "p-map": "^7.0.4",
"package-directory": "^8.1.0", "package-directory": "^8.1.0",
"path-to-regexp": "^6.3.0", "path-to-regexp": "^6.3.0",
"picocolors": "^1.1.1", "picocolors": "^1.1.1",
"picomatch": "^4.0.3", "picomatch": "^4.0.3",
"playwright-chromium": "^1.55.0", "playwright-chromium": "^1.56.1",
"polka": "^1.0.0-next.28", "polka": "^1.0.0-next.28",
"postcss": "^8.5.6", "postcss": "^8.5.6",
"postcss-selector-parser": "^7.1.0", "postcss-selector-parser": "^7.1.0",
"prettier": "^3.6.2", "prettier": "^3.6.2",
"prompts": "^2.4.2", "prompts": "^2.4.2",
"punycode": "^2.3.1", "punycode": "^2.3.1",
"rimraf": "^6.0.1", "rimraf": "^6.1.0",
"rollup": "^4.49.0", "rollup": "^4.53.2",
"rollup-plugin-dts": "6.1.1", "rollup-plugin-dts": "6.1.1",
"rollup-plugin-esbuild": "^6.2.1", "rollup-plugin-esbuild": "^6.2.1",
"semver": "^7.7.2", "semver": "^7.7.3",
"simple-git-hooks": "^2.13.1", "simple-git-hooks": "^2.13.1",
"sirv": "^3.0.1", "sirv": "^3.0.2",
"sitemap": "^8.0.0", "sitemap": "^9.0.0",
"tinyglobby": "^0.2.14", "tinyglobby": "^0.2.15",
"typescript": "^5.9.2", "typescript": "^5.9.3",
"vitest": "4.0.0-beta.4", "vitest": "4.0.0-beta.4",
"vue-tsc": "^3.0.6", "vue-tsc": "^3.1.3",
"wait-on": "^8.0.4" "wait-on": "^9.0.3"
}, },
"peerDependencies": { "peerDependencies": {
"markdown-it-mathjax3": "^4", "markdown-it-mathjax3": "^4",
"oxc-minify": "^0.82.3", "oxc-minify": "*",
"postcss": "^8" "postcss": "^8"
}, },
"peerDependenciesMeta": { "peerDependenciesMeta": {
@ -208,5 +208,5 @@
"optional": true "optional": true
} }
}, },
"packageManager": "pnpm@10.14.0" "packageManager": "pnpm@10.22.0"
} }

23
patches/@types__markdown-it-attrs.patch
Unescape View File

@ -0,0 +1,23 @@
diff --git a/index.d.ts b/index.d.ts
index 41d4a858c6ece5a61a2088733cf8b333b45603d8..2cb19bcd8fc76ae82ebe87af742916e17f49334b 100644
--- a/index.d.ts
+++ b/index.d.ts
@@ -1,3 +1,15 @@
-import MarkdownIt = require("markdown-it");
-declare function attrs(md: MarkdownIt): void;
-export = attrs;
+import type MarkdownIt from 'markdown-it'
+
+export interface MarkdownItAttrsOptions {
+ /** left delimiter, default is `{`(left curly bracket) */
+ leftDelimiter?: string
+ /** right delimiter, default is `}`(right curly bracket) */
+ rightDelimiter?: string
+ /** rule of allowed attribute, empty means no limit */
+ allowedAttributes?: (string | RegExp)[]
+}
+
+export default function attrsPlugin(
+ md: MarkdownIt,
+ options?: MarkdownItAttrsOptions
+): void

2392
pnpm-lock.yaml
View File

File diff suppressed because it is too large Load Diff

4
pnpm-workspace.yaml
Unescape View File

@ -2,6 +2,8 @@ packages:
- docs - docs
- __tests__/* - __tests__/*
autoInstallPeers: false
onlyBuiltDependencies: onlyBuiltDependencies:
- esbuild - esbuild
- playwright-chromium - playwright-chromium
@ -12,8 +14,8 @@ overrides:
vite: npm:rolldown-vite@latest vite: npm:rolldown-vite@latest
patchedDependencies: patchedDependencies:
'@types/markdown-it-attrs': patches/@types__markdown-it-attrs.patch
'@types/mdurl@2.0.0': patches/@types__mdurl@2.0.0.patch '@types/mdurl@2.0.0': patches/@types__mdurl@2.0.0.patch
markdown-it-anchor@9.2.0: patches/markdown-it-anchor@9.2.0.patch markdown-it-anchor@9.2.0: patches/markdown-it-anchor@9.2.0.patch
autoInstallPeers: false
shellEmulator: true shellEmulator: true

0
src/client/shim.d.ts → src/client/shims.d.ts vendored
Unescape View File

98
src/node/markdown/markdown.ts
Unescape View File

@ -20,8 +20,8 @@ import type {
ThemeRegistrationAny ThemeRegistrationAny
} from '@shikijs/types' } from '@shikijs/types'
import anchorPlugin from 'markdown-it-anchor' import anchorPlugin from 'markdown-it-anchor'
import { MarkdownItAsync, type Options } from 'markdown-it-async' import { MarkdownItAsync, type MarkdownItAsyncOptions } from 'markdown-it-async'
import attrsPlugin from 'markdown-it-attrs' import attrsPlugin, { type MarkdownItAttrsOptions } from 'markdown-it-attrs'
import mditCjkFriendly from 'markdown-it-cjk-friendly' import mditCjkFriendly from 'markdown-it-cjk-friendly'
import { full as emojiPlugin } from 'markdown-it-emoji' import { full as emojiPlugin } from 'markdown-it-emoji'
import type { BuiltinLanguage, BuiltinTheme, Highlighter } from 'shiki' import type { BuiltinLanguage, BuiltinTheme, Highlighter } from 'shiki'
@ -48,7 +48,7 @@ export type ThemeOptions =
dark: ThemeRegistrationAny | BuiltinTheme dark: ThemeRegistrationAny | BuiltinTheme
} }
export interface MarkdownOptions extends Options { export interface MarkdownOptions extends MarkdownItAsyncOptions {
/* ==================== General Options ==================== */ /* ==================== General Options ==================== */
/** /**
@ -153,12 +153,7 @@ export interface MarkdownOptions extends Options {
* Options for `markdown-it-attrs` * Options for `markdown-it-attrs`
* @see https://github.com/arve0/markdown-it-attrs * @see https://github.com/arve0/markdown-it-attrs
*/ */
attrs?: { attrs?: MarkdownItAttrsOptions & { disable?: boolean }
leftDelimiter?: string
rightDelimiter?: string
allowedAttributes?: Array<string | RegExp>
disable?: boolean
}
/** /**
* Options for `markdown-it-emoji` * Options for `markdown-it-emoji`
* @see https://github.com/markdown-it/markdown-it-emoji * @see https://github.com/markdown-it/markdown-it-emoji
@ -230,7 +225,10 @@ export interface MarkdownOptions extends Options {
export type MarkdownRenderer = MarkdownItAsync export type MarkdownRenderer = MarkdownItAsync
let md: MarkdownRenderer | undefined // highlight is marked as any to avoid type conflicts with plugins expecting
// regular markdown-it which has sync highlight function. Such plugins will fail
// if they access highlight directly but currently none of the ones we use do that.
let md: (MarkdownRenderer & { options: { highlight?: any } }) | undefined
let _disposeHighlighter: (() => void) | undefined let _disposeHighlighter: (() => void) | undefined
export function disposeMdItInstance() { export function disposeMdItInstance() {
@ -263,7 +261,7 @@ export async function createMarkdownRenderer(
md = new MarkdownItAsync({ html: true, linkify: true, highlight, ...options }) md = new MarkdownItAsync({ html: true, linkify: true, highlight, ...options })
md.linkify.set({ fuzzyLink: false }) md.linkify.set({ fuzzyLink: false })
md.use(restoreEntities) restoreEntities(md)
if (options.preConfig) { if (options.preConfig) {
await options.preConfig(md) await options.preConfig(md)
@ -272,22 +270,22 @@ export async function createMarkdownRenderer(
const slugify = options.anchor?.slugify ?? defaultSlugify const slugify = options.anchor?.slugify ?? defaultSlugify
// custom plugins // custom plugins
md.use(componentPlugin, { ...options.component }) componentPlugin(md, options.component)
.use(highlightLinePlugin) highlightLinePlugin(md)
.use(preWrapperPlugin, { preWrapperPlugin(md, {
codeCopyButtonTitle, codeCopyButtonTitle,
languageLabel: options.languageLabel languageLabel: options.languageLabel
}) })
.use(snippetPlugin, srcDir) snippetPlugin(md, srcDir)
.use(containerPlugin, options.container) containerPlugin(md, options.container)
.use(imagePlugin, options.image) imagePlugin(md, options.image)
.use( linkPlugin(
linkPlugin, md,
{ target: '_blank', rel: 'noreferrer', ...options.externalLinks }, { target: '_blank', rel: 'noreferrer', ...options.externalLinks },
base, base,
slugify slugify
) )
.use(lineNumberPlugin, options.lineNumbers) lineNumberPlugin(md, options.lineNumbers)
const tableOpen = md.renderer.rules.table_open const tableOpen = md.renderer.rules.table_open
md.renderer.rules.table_open = function (tokens, idx, options, env, self) { md.renderer.rules.table_open = function (tokens, idx, options, env, self) {
@ -299,17 +297,17 @@ export async function createMarkdownRenderer(
} }
if (options.gfmAlerts !== false) { if (options.gfmAlerts !== false) {
md.use(gitHubAlertsPlugin, options.container) gitHubAlertsPlugin(md, options.container)
} }
// third party plugins // third party plugins
if (!options.attrs?.disable) { if (!options.attrs?.disable) {
md.use(attrsPlugin, options.attrs) attrsPlugin(md, options.attrs)
} }
md.use(emojiPlugin, { ...options.emoji }) emojiPlugin(md, options.emoji)
// mdit-vue plugins // mdit-vue plugins
md.use(anchorPlugin, { anchorPlugin(md, {
slugify, slugify,
getTokensText: (tokens) => { getTokensText: (tokens) => {
return tokens return tokens
@ -343,35 +341,33 @@ export async function createMarkdownRenderer(
state.tokens[idx + 1].children?.push(...linkTokens) state.tokens[idx + 1].children?.push(...linkTokens)
}, },
...options.anchor ...options.anchor
} as anchorPlugin.AnchorOptions).use(frontmatterPlugin, { })
...options.frontmatter
} as FrontmatterPluginOptions) frontmatterPlugin(md, options.frontmatter)
if (options.headers) { if (options.headers) {
md.use(headersPlugin, { headersPlugin(md, {
level: [2, 3, 4, 5, 6], level: [2, 3, 4, 5, 6],
slugify, slugify,
...(typeof options.headers === 'boolean' ? undefined : options.headers) ...(typeof options.headers === 'boolean' ? undefined : options.headers)
} as HeadersPluginOptions) })
} }
md.use(sfcPlugin, { sfcPlugin(md, options.sfc)
...options.sfc titlePlugin(md)
} as SfcPluginOptions) tocPlugin(md, {
.use(titlePlugin) slugify,
.use(tocPlugin, { ...options.toc,
slugify, format: (s) => {
...options.toc, const title = s.replaceAll('&amp;', '&') // encoded twice because of restoreEntities
format: (s) => { return options.toc?.format?.(title) ?? title
const title = s.replaceAll('&amp;', '&') // encoded twice because of restoreEntities }
return options.toc?.format?.(title) ?? title })
}
} as TocPluginOptions)
if (options.math) { if (options.math) {
try { try {
const mathPlugin = await import('markdown-it-mathjax3') const mathPlugin = await import('markdown-it-mathjax3')
md.use(mathPlugin.default ?? mathPlugin, { ;(mathPlugin.default ?? mathPlugin)(md, {
...(typeof options.math === 'boolean' ? {} : options.math) ...(typeof options.math === 'boolean' ? {} : options.math)
}) })
const origMathInline = md.renderer.rules.math_inline! const origMathInline = md.renderer.rules.math_inline!
@ -388,13 +384,13 @@ export async function createMarkdownRenderer(
} }
} catch (error) { } catch (error) {
throw new Error( throw new Error(
'You need to install `markdown-it-mathjax3` to use math support.' 'You need to install `markdown-it-mathjax3@^4` to use math support.'
) )
} }
} }
if (options.cjkFriendlyEmphasis !== false && options.cjkFriendly !== false) { if (options.cjkFriendlyEmphasis !== false && options.cjkFriendly !== false) {
md.use(mditCjkFriendly) mditCjkFriendly(md)
} }
// apply user config // apply user config

20
src/node/markdown/plugins/highlight.ts
Unescape View File

@ -127,20 +127,16 @@ export async function highlight(
} }
] ]
const vueRE = /-vue(?=:|$)/ // keep in sync with ./preWrapper.ts#extractLang
const lineNoStartRE = /=(\d*)/ const langRE = /^[a-zA-Z0-9-_]+/
const lineNoRE = /:(no-)?line-numbers(=\d*)?$/ const vueRE = /-vue$/
const mustacheRE = /\{\{.*?\}\}/g
return [ return [
async (str: string, lang: string, attrs: string) => { async (str: string, lang: string, attrs: string) => {
const vPre = vueRE.test(lang) ? '' : 'v-pre' lang = langRE.exec(lang)?.[0].toLowerCase() || defaultLang
lang =
lang const vPre = !vueRE.test(lang)
.replace(lineNoStartRE, '') if (!vPre) lang = lang.slice(0, -4)
.replace(lineNoRE, '')
.replace(vueRE, '')
.toLowerCase() || defaultLang
try { try {
// https://github.com/shikijs/shiki/issues/952 // https://github.com/shikijs/shiki/issues/952
@ -164,7 +160,7 @@ export async function highlight(
const removeMustache = (s: string) => { const removeMustache = (s: string) => {
if (vPre) return s if (vPre) return s
return s.replace(mustacheRE, (match) => { return s.replace(/\{\{.*?\}\}/g, (match) => {
let marker = mustaches.get(match) let marker = mustaches.get(match)
if (!marker) { if (!marker) {
marker = nanoid() marker = nanoid()

6
src/node/markdown/plugins/lineNumbers.ts
Unescape View File

@ -12,14 +12,14 @@ export const lineNumberPlugin = (md: MarkdownItAsync, enable = false) => {
const info = tokens[idx].info const info = tokens[idx].info
if ( if (
(!enable && !/:line-numbers($| |=)/.test(info)) || (!enable && !/:line-numbers\b/.test(info)) ||
(enable && /:no-line-numbers($| )/.test(info)) (enable && /:no-line-numbers\b/.test(info))
) { ) {
return rawCode return rawCode
} }
let startLineNumber = 1 let startLineNumber = 1
const matchStartLineNumber = info.match(/=(\d*)/) const matchStartLineNumber = info.match(/=(\d+)/)
if (matchStartLineNumber && matchStartLineNumber[1]) { if (matchStartLineNumber && matchStartLineNumber[1]) {
startLineNumber = parseInt(matchStartLineNumber[1]) startLineNumber = parseInt(matchStartLineNumber[1])
} }

16
src/node/markdown/plugins/preWrapper.ts
Unescape View File

@ -44,12 +44,12 @@ export function extractTitle(info: string, html = false) {
return info.match(/\[(.*)\]/)?.[1] || extractLang(info) || 'txt' return info.match(/\[(.*)\]/)?.[1] || extractLang(info) || 'txt'
} }
function extractLang(info: string) { function extractLang(info: string): string {
return info return (
.trim() /^[a-zA-Z0-9-_]+/
.replace(/=(\d*)/, '') .exec(info)?.[0]
.replace(/:(no-)?line-numbers({| |$|=\d*).*/, '') .replace(/-vue$/, '') // remove -vue suffix
.replace(/(-vue|{| ).*$/, '') .replace(/^vue-html$/, 'template')
.replace(/^vue-html$/, 'template') .replace(/^ansi$/, '') || ''
.replace(/^ansi$/, '') )
} }

Write Preview
Loading…
Cancel
Save