Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions src/theme/prism-include-languages.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/**
* Prism is used to syntax highlight code blocks in markdown files.
*
* Original source:
* @link https://github.com/facebook/docusaurus/blob/main/packages/docusaurus-theme-classic/src/theme/prism-include-languages.ts
*
* Reason for overriding:
* - Add Vue language support since it's not included in Prism
*/

import siteConfig from '@generated/docusaurus.config';
import type * as PrismNamespace from 'prismjs';
import type { Optional } from 'utility-types';

export default function prismIncludeLanguages(PrismObject: typeof PrismNamespace): void {
const {
themeConfig: { prism },
} = siteConfig;
const { additionalLanguages } = prism as { additionalLanguages: string[] };

// Prism components work on the Prism instance on the window, while prism-
// react-renderer uses its own Prism instance. We temporarily mount the
// instance onto window, import components to enhance it, then remove it to
// avoid polluting global namespace.
// You can mutate PrismObject: registering plugins, deleting languages... As
// long as you don't re-assign it

const PrismBefore = globalThis.Prism;
globalThis.Prism = PrismObject;

additionalLanguages.forEach((lang) => {
if (lang === 'php') {
// eslint-disable-next-line global-require
require('prismjs/components/prism-markup-templating.js');
}
// eslint-disable-next-line global-require, import/no-dynamic-require
require(`prismjs/components/prism-${lang}`);
});

// CUSTOM CODE
require('../theme/prism-languages/prism-vue');
// CUSTOM CODE END

// Clean up and eventually restore former globalThis.Prism object (if any)
delete (globalThis as Optional<typeof globalThis, 'Prism'>).Prism;
if (typeof PrismBefore !== 'undefined') {
globalThis.Prism = PrismObject;
}
}
44 changes: 44 additions & 0 deletions src/theme/prism-languages/prism-vue.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
(function (Prism) {
Prism.languages.vue = Prism.languages.extend('markup', {
// Add Vue template interpolation (e.g., {{ expression }})
interpolation: {
pattern: /\{\{[^}]+\}\}/,
inside: {
punctuation: /\{\{|\}\}/,
expression: {
pattern: /[\s\S]+/,
inside: Prism.languages.javascript,
},
},
},

// Add Vue-specific attributes (v-bind, @click, :prop)
attribute: {
pattern: /(^|["'\s])(?:v-|:|\@|#)[\w-]+(?:\.[\w-]+)*(?=[^\w-])(?=[^=>]*=)/,
lookbehind: true,
alias: 'keyword',
},
});

Prism.languages.insertBefore('vue', 'comment', {
script: {
pattern: /<script[\s\S]*?>[\s\S]*?<\/script>/i,
inside: {
rest: Prism.languages.javascript,
},
alias: 'language-javascript',
},
style: {
pattern: /<style[\s\S]*?>[\s\S]*?<\/style>/i,
inside: {
rest: Prism.languages.css,
},
alias: 'language-css',
},
});

Prism.languages.html = Prism.languages.vue;
Prism.languages.markup = Prism.languages.vue;

Prism.languages.v = Prism.languages.vue;
})(Prism);