umberto 7.0.2 → 8.0.0

package/scripts/filter/before-post-render/gloria/render-post-render-pug-components.js

@@ -0,0 +1,94 @@
+/**
+ * @license Copyright (c) 2017-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const cheerio = require( 'cheerio' );
+const createPrerenderPugTemplate = require( '../../../utils/pug-renderer/create-prerender-pug-template' );
+
+/**
+ * Components to be processed after markdown rendering
+ */
+const POST_RENDER_COMPONENTS = [
+	{
+		fastCheck: str => str.includes( '<pre' ) && str.includes( 'highlight' ),
+		selector: 'pre.highlight',
+		handler: ( () => {
+			const template = createPrerenderPugTemplate( {
+				hexo,
+				requires: [
+					'_components/svg/index',
+					'_components/icon/index',
+					'_components/tooltip-popover/index',
+					'_components/skeleton/index',
+					'_components/code-block/index'
+				],
+				skipCacheIf: ( { code } ) => code?.split( '\n' ).length > 1,
+				component: 'code-block',
+				componentAttrs: {
+					static: {
+						copyable: true
+					},
+					dynamic: [ 'copyable', 'language' ],
+					mask: [ 'code' ]
+				}
+			} );
+
+			return $element => {
+				const $code = $element.find( 'code' );
+
+				if ( !$code.length ) {
+					return null;
+				}
+
+				// Get the language from the class (e.g., "language-js" -> "js")
+				const language = $code.attr( 'class' ).replace( 'doc', '' ).trim();
+
+				return template( {
+					code: $code.html(),
+					language
+				} );
+			};
+		} )()
+	}
+];
+
+hexo.extend.filter.register( 'after_post_render', page => {
+	if ( page.projectTheme !== 'gloria' || !page.content ) {
+		return page;
+	}
+
+	try {
+		let $ = null;
+		let hasChanges = false;
+
+		POST_RENDER_COMPONENTS.forEach( component => {
+			if ( component.fastCheck && !component.fastCheck( page.content ) ) {
+				return;
+			}
+
+			$ = $ || cheerio.load( page.content );
+
+			$( component.selector ).each( ( i, element ) => {
+				const $element = $( element );
+				const replacement = component.handler( $element, { hexo, page } );
+
+				if ( replacement ) {
+					$element.replaceWith( replacement );
+					hasChanges = true;
+				}
+			} );
+		} );
+
+		if ( hasChanges ) {
+			page.content = $.html();
+		}
+	} catch ( error ) {
+		console.error( error );
+		throw error;
+	}
+
+	return page;
+} );

package/scripts/filter/before-post-render/set-layout.js

@@ -10,7 +10,9 @@
  * page.layout indicates the template which should be used to render the page.
  */
 hexo.extend.filter.register( 'before_post_render', page => {
-	const theme = page.projectName === 'ckeditor4' ? 'umberto' : 'gloria';
+	const theme = [ 'ckeditor4', 'ckfinder' ].includes( page.projectName ) ? 'umberto' : 'gloria';
+
+	page.projectTheme = theme;
 
 	if ( page.category === 'api-reference' ) {
 		page.layout = theme + '/api';
@@ -23,4 +25,4 @@ hexo.extend.filter.register( 'before_post_render', page => {
 	} else {
 		page.layout = theme + '/' + page.layout;
 	}
-} );
+}, 3 );

package/scripts/helper/parse-href.js

@@ -0,0 +1,28 @@
+/**
+ * @license Copyright (c) 2017-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const parseHref = require( '../utils/parse-href' );
+
+/**
+ * Parses an href string to generate a relative URL. If the href contains a cross-project reference, it will be logged.
+ * If the href is invalid or the target page cannot be found, an error will be returned.
+ *
+ * @param {String} str The href string to parse
+ * @param {Object} data Data object containing path and project information
+ * @return {String} The parsed relative URL
+ */
+hexo.extend.helper.register( 'uParseHref', function( str, data ) {
+	return parseHref( str, {
+		path: data.path,
+		projectName: data.projectName,
+		projectGlobals: hexo.projectGlobals,
+		BASE_PATH: data.BASE_PATH
+	}, hexo, {
+		relativeUrlHelper: hexo.extend.helper.store.relative_url,
+		isSilentError: true
+	} );
+} );

package/scripts/helper/u-capitalize.js

@@ -0,0 +1,13 @@
+/**
+ * @license Copyright (c) 2017-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const capitalize = require( '../utils/capitalize' );
+
+/**
+ * Capitalizes the first letter of a string.
+ */
+hexo.extend.helper.register( 'uCapitalize', capitalize );

package/scripts/helper/u-random-id.js

@@ -0,0 +1,16 @@
+/**
+ * @license Copyright (c) 2017-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const { randomId } = require( '../utils/random-id' );
+
+/**
+ * Generates a random UUID (v4). If a prefix is provided, it will be prepended to the UUID.
+ *
+ * @param {String} [prefix] Optional prefix to add to the UUID
+ * @return {String} The generated UUID with optional prefix
+ */
+hexo.extend.helper.register( 'uRandomId', randomId );

package/scripts/helper/u-remove-indentation.js

@@ -0,0 +1,13 @@
+/**
+ * @license Copyright (c) 2017-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const removeIndentation = require( '../utils/remove-indentation' );
+
+/**
+ * Removes indentation from a given string.
+ */
+hexo.extend.helper.register( 'uRemoveIndentation', removeIndentation );

package/scripts/helper/u-toc.js

@@ -5,67 +5,6 @@
 
 'use strict';
 
-const cheerio = require( 'cheerio' );
+const toc = require( '../utils/toc' );
 
-hexo.extend.helper.register( 'uToc', ( data, options = {} ) => {
-	const $ = cheerio.load( data, null, false );
-
-	let usedHeadings = [ 'h2', 'h3', 'h4', 'h5', 'h6' ];
-
-	if ( options.tocLimit >= 0 ) {
-		usedHeadings = usedHeadings.slice( 0, options.tocLimit );
-	}
-
-	usedHeadings = usedHeadings.join( ',' );
-
-	const headings = $( usedHeadings )
-		.filter( function() {
-			return !$( this ).parents( '.live-snippet, .collapsing-list__item' ).length;
-		} );
-	const className = options.class || 'secondary-navigation';
-
-	if ( !headings.length ) {
-		return '';
-	}
-
-	const $r = cheerio.load( `<nav class=${ className }><h3>Table of contents</h3></nav>`, null, false ); // result object
-	const tocLastLevels = [ $r( 'nav' ), 0, 0, 0, 0, 0, 0 ];
-
-	headings.each( function() {
-		const hLevel = Number( this.name[ 1 ] );
-		const id = $r( this ).attr( 'id' );
-		const text = $r( this ).find( '.headerlink' ).remove().end().text().trim()
-			// Replace the chevrons with their HTML escape characters to avoid rendering HTML in ToC.
-			.replace( /</g, '&lt;' )
-			.replace( />/g, '&gt;' );
-
-		const newItem = `<li><a href="#${ id }" title="${ text }">${ text }</a></li>`;
-
-		if ( tocLastLevels[ hLevel ] ) {
-			// If there already is a parent node for current heading level, append the new toc item there.
-			tocLastLevels[ hLevel ].append( newItem );
-		} else {
-			// If there's no parent node for current heading level, create it and append.
-			if ( $r( 'li' ).length ) {
-				$r( 'li' ).last().append( `<ol>${ newItem }</ol>` );
-			} else {
-				$r( 'nav' ).append( `<ol>${ newItem }</ol>` );
-			}
-
-			// Assign new created <ol> element to the helper array.
-			tocLastLevels[ hLevel ] = $r( 'ol' ).last();
-		}
-
-		// After adding new toc item, lower heading levels in helper array must be cleared.
-		// If e.g. level 2 <ol> was added, then level 3 nd lower <ol>s are no longer needed because they belong to upper toc nodes.
-		clearLowerLevels( tocLastLevels, hLevel );
-	} );
-
-	return $r.html();
-} );
-
-function clearLowerLevels( levels, current ) {
-	for ( let i = current + 1; i < levels.length; i++ ) {
-		levels[ i ] = 0;
-	}
-}
+hexo.extend.helper.register( 'uToc', toc );

package/scripts/utils/add-indention.js

@@ -0,0 +1,16 @@
+/**
+ * @license Copyright (c) 2017-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+/**
+ * Adds indentation to the content.
+ */
+module.exports = function addIndention( indent, content ) {
+	return content
+		.split( '\n' )
+		.map( line => `${ indent }${ line }` )
+		.join( '\n' );
+};

package/scripts/utils/capitalize.js

@@ -0,0 +1,17 @@
+/**
+ * @license Copyright (c) 2017-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+/**
+ * Capitalizes the first letter of a string.
+ */
+module.exports = function capitalize( str ) {
+	if ( typeof str !== 'string' ) {
+		return '';
+	}
+
+	return str.charAt( 0 ).toUpperCase() + str.slice( 1 );
+};

package/scripts/utils/concat-url-parts.js

@@ -0,0 +1,19 @@
+/**
+ * @license Copyright (c) 2017-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const dropInitSlash = require( './drop-init-slash' );
+const dropTrailingSlash = require( './drop-trailing-slash' );
+const pipe = require( './pipe' );
+
+module.exports = function concatUrlParts( ...urls ) {
+	return (
+		urls
+			.filter( Boolean )
+			.map( pipe( dropTrailingSlash, dropInitSlash ) )
+			.join( '/' )
+	);
+};

package/scripts/utils/decode-html-entities.js

@@ -0,0 +1,25 @@
+/**
+ * @license Copyright (c) 2017-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+/**
+ * Decodes common HTML entities in a string.
+ *
+ * @param {string} text - Text that may contain HTML entities
+ * @returns {string} Text with HTML entities replaced with their corresponding characters
+ */
+module.exports = function decodeHtmlEntities( text ) {
+	return text
+		.replace( / /g, ' ' )
+		.replace( /&/g, '&' )
+		.replace( /&lt;/g, '<' )
+		.replace( /&gt;/g, '>' )
+		.replace( /&quot;/g, '"' )
+		.replace( /&apos;/g, '\'' )
+		.replace( /&mdash;/g, '—' )
+		.replace( /&ndash;/g, '–' )
+		.replace( /&hellip;/g, '…' );
+};

package/scripts/utils/drop-init-slash.js

@@ -0,0 +1,14 @@
+/**
+ * @license Copyright (c) 2017-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+module.exports = function dropInitSlash( url ) {
+	if ( url.startsWith( '/' ) ) {
+		return url.slice( 1 );
+	}
+
+	return url;
+};

package/scripts/utils/drop-trailing-slash.js

@@ -0,0 +1,14 @@
+/**
+ * @license Copyright (c) 2017-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+module.exports = function dropTrailingSlash( url ) {
+	if ( url.endsWith( '/' ) ) {
+		return url.slice( 0, -1 );
+	}
+
+	return url;
+};

package/scripts/utils/drop-url-protocol.js

@@ -0,0 +1,10 @@
+/**
+ * @license Copyright (c) 2017-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+module.exports = function dropUrlProtocol( url ) {
+	return url.replace( /^[a-zA-Z][a-zA-Z0-9+.-]*:\/\//, '' );
+};

package/scripts/utils/inline-svg.js

@@ -0,0 +1,152 @@
+/**
+ * @license Copyright (c) 2017-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const cheerio = require( 'cheerio' );
+const fs = require( 'fs' );
+const path = require( 'path' );
+
+const HexoManager = require( '../../src/hexo-manager' );
+
+/**
+ * Cache for parsed SVG elements.
+ */
+const SVG_CACHE = new Map();
+
+module.exports = function inlineSvg( str, isDocument = true ) {
+	const $ = cheerio.load( str, null, isDocument );
+
+	// Find all elements with data-inline-svg-image attribute.
+	$( '[data-inline-svg-image]' ).each( function() {
+		const element = $( this );
+		const svgPath = element.attr( 'data-inline-svg-image' );
+		const fillColor = element.attr( 'data-inline-svg-fill-color' );
+		const trimDimensions = element.attr( 'data-inline-svg-trim-dimensions' ) !== undefined;
+		const title = element.attr( 'data-inline-svg-title' );
+
+		// Construct the absolute path to the SVG file.
+		// Assuming the path is relative to the Hexo root.
+		const absolutePath = path.join( HexoManager.hexo.theme_dir, svgPath );
+
+		// Read the SVG file content
+		if ( !fs.existsSync( absolutePath ) ) {
+			console.warn( `SVG file not found: ${ absolutePath }` );
+			return;
+		}
+
+		// Generate a cache key based on file path, fill color, trim dimensions and title
+		const cacheKey = JSON.stringify( {
+			path: absolutePath,
+			fillColor: fillColor || 'default',
+			trimDimensions,
+			title: title || null
+		} );
+
+		let $svg;
+
+		// Try to get the SVG from cache first.
+		if ( SVG_CACHE.has( cacheKey ) ) {
+			$svg = SVG_CACHE.get( cacheKey );
+		} else {
+			// Parse the SVG.
+			const svgContent = fs.readFileSync( absolutePath, 'utf8' );
+
+			$svg = cheerio.load( svgContent, { xmlMode: true } )( 'svg' );
+
+			// Apply fill color if specified.
+			if ( fillColor ) {
+				applyFillColor( $, $svg, fillColor );
+			}
+
+			// Remove width and height if trimDimensions is true
+			if ( trimDimensions ) {
+				trimSvgDimensions( $, $svg );
+			}
+
+			// Add title if specified
+			if ( title ) {
+				addTitle( $, $svg, title );
+			}
+
+			// Store in cache.
+			SVG_CACHE.set( cacheKey, $svg );
+		}
+
+		// Copy original element's attributes to SVG.
+		const elementAttributes = element.attr();
+		let svgCloned = false;
+
+		for ( const attr in elementAttributes ) {
+			if ( attr.startsWith( 'data-inline-svg-' ) ) {
+				continue;
+			}
+
+			if ( !svgCloned ) {
+				$svg = $svg.clone();
+				svgCloned = true;
+			}
+
+			$svg.attr( attr, elementAttributes[ attr ] );
+		}
+
+		// Replace the original element with the SVG.
+		element.replaceWith( $svg.toString() );
+	} );
+
+	$( '[data-inline-svg-image]' ).removeAttr( 'data-spritesheet-svg' );
+
+	return $.html();
+};
+
+/**
+ * Applies fill color to an SVG element.
+ */
+function applyFillColor( $, $svg, fillColor ) {
+	// Replace all fill attributes with the specified color.
+	$svg.find( '[fill]' ).each( function() {
+		$( this ).attr( 'fill', fillColor );
+	} );
+
+	// Also check the root SVG for fill attribute.
+	if ( $svg.attr( 'fill' ) ) {
+		$svg.attr( 'fill', fillColor );
+	}
+
+	return $svg;
+}
+
+/**
+ * Removes width and height attributes from SVG elements.
+ */
+function trimSvgDimensions( $, $svg ) {
+	$svg.removeAttr( 'width' );
+	$svg.removeAttr( 'height' );
+	return $svg;
+}
+
+/**
+ * Adds or updates a title element in the SVG.
+ */
+function addTitle( $, $svg, title ) {
+	if ( [ '', 'none', 'false', 'null' ].includes( title ) ) {
+		return $svg;
+	}
+
+	// Check if SVG already has a title
+	const existingTitle = $svg.find( 'title' );
+
+	if ( existingTitle.length ) {
+		// Update existing title
+		existingTitle.text( title );
+	} else {
+		// Create new title and add it as the first child
+		const $title = $( '<title></title>' ).text( title );
+		$svg.prepend( $title );
+	}
+
+	return $svg;
+}
+

package/scripts/utils/measure-call.js

@@ -0,0 +1,16 @@
+/**
+ * @license Copyright (c) 2017-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+module.exports = function measureCall( fn, ...args ) {
+	const start = performance.now();
+	const result = fn( ...args );
+	const end = performance.now();
+
+	console.log( `Function ${ fn.name } executed in ${ ( end - start ).toFixed( 2 ) } ms` );
+
+	return result;
+};

package/scripts/utils/parse-href.js

@@ -0,0 +1,37 @@
+/**
+ * @license Copyright (c) 2017-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const { linkToApi, linkToSdk, linkToGuide } = require( './parselinks' );
+
+/**
+ * Parses an href link from a string and returns the appropriate URL.
+ *
+ * @param {String} str The string containing the href link to parse
+ * @param {Object} data The page data object
+ * @param {Object} hexo The Hexo instance
+ * @param {Object} options Options object
+ * @param {Function} options.relativeUrlHelper Helper function to generate relative URLs
+ * @param {Boolean} options.isSilentError Whether to silence error messages
+ * @returns {String} The parsed URL
+ */
+module.exports = function parseHref( str, data, hexo, options ) {
+	const { relativeUrlHelper, isSilentError } = options;
+	const rgxp = /\\?{(?:@linkapi|@link|@linksdk|@linkexample)\s+[^{]+?({[^}]+})?[^{}]*\\?}/g;
+	const match = rgxp.exec( str )?.[ 0 ];
+
+	if ( !match ) {
+		return str;
+	}
+
+	if ( match.includes( 'module:' ) || match.includes( '@linkapi' ) ) {
+		return linkToApi( match, data, hexo, { relativeUrlHelper, isSilentError }, true );
+	} else if ( match.includes( '@linksdk' ) || match.includes( '@linkexample' ) ) {
+		return linkToSdk( match, data, hexo, { relativeUrlHelper, isSilentError }, true );
+	} else {
+		return linkToGuide( match, data, hexo, { relativeUrlHelper, isSilentError }, true );
+	}
+};

package/scripts/utils/parseicontag.js

@@ -49,7 +49,7 @@ module.exports = function parseIconTag( page, hexo ) {
 
 		return [
 			'<span class="editor-icon">' +
-				`<img src="${ relativeUrlHelper( page.path, absoluteLikePath ) }" class="editor-icon__image" ${ alt }/>` +
+				`<img src="${ relativeUrlHelper( page.path, absoluteLikePath ) }" loading="lazy" class="editor-icon__image" ${ alt }/>` +
 			'</span>'
 		].join( '' );
 	} );

package/scripts/utils/parselinks.js

@@ -22,7 +22,7 @@ const logCrossProjectReference = require( './logcrossprojectreference' );
  * @param {Object} hexo
  * @return {Boolean}
  */
-module.exports = function parseLinks( page, hexo ) {
+function parseLinks( page, hexo ) {
 	const isSilentError = hexo.projectGlobals.common._disabledFilters.has( parseLinks.name );
 	const relativeUrlHelper = hexo.extend.helper.store.relative_url;
 
@@ -50,7 +50,7 @@ module.exports = function parseLinks( page, hexo ) {
  * @param {Function} options.relativeUrlHelper
  * @param {Boolean} options.isSilentError
  */
-function linkToApi( str, data, hexo, { relativeUrlHelper, isSilentError } ) {
+function linkToApi( str, data, hexo, { relativeUrlHelper, isSilentError }, onlyHref = false ) {
 	const linkMatchResult = str.match( /^{((?:@linkapi|@link)[\s\S]+)}$/ );
 
 	if ( !linkMatchResult ) {
@@ -174,6 +174,10 @@ function linkToApi( str, data, hexo, { relativeUrlHelper, isSilentError } ) {
 		linkText = `event-${ targetDoclet.name }`;
 	}
 
+	if ( onlyHref ) {
+		return href;
+	}
+
 	return getOutputLink( href, linkText, !!linkContentMatchResult[ 3 ] );
 }
 
@@ -231,7 +235,7 @@ function getOutputLink( href, description, isCustomDescription ) {
  * @param {Function} options.relativeUrlHelper
  * @param {Boolean} options.isSilentError
  */
-function linkToSdk( str, data, hexo, { relativeUrlHelper, isSilentError } ) {
+function linkToSdk( str, data, hexo, { relativeUrlHelper, isSilentError }, onlyHref = false ) {
 	const regExp = /(?:@linksdk|@linkexample) (?:@(\w+) )?(\w+)(?:\.html)?(#\S+)? ([^}]+)/;
 	const match = regExp.exec( str );
 
@@ -256,8 +260,13 @@ function linkToSdk( str, data, hexo, { relativeUrlHelper, isSilentError } ) {
 	const sdkFileHash = match[ 3 ] || '';
 	const sdkLinkName = match[ 4 ];
 	const link = relativeUrlHelper( data.path, upath.join( basePath, sdkSlug, sdkFileName ) );
+	const finalHref = `${ link }.html${ sdkFileHash }`;
+
+	if ( onlyHref ) {
+		return finalHref;
+	}
 
-	return `<a href="${ link }.html${ sdkFileHash }">${ sdkLinkName }</a>`;
+	return `<a href="${ finalHref }">${ sdkLinkName }</a>`;
 }
 
 /**
@@ -268,7 +277,7 @@ function linkToSdk( str, data, hexo, { relativeUrlHelper, isSilentError } ) {
  * @param {Function} options.relativeUrlHelper
  * @param {Boolean} options.isSilentError
  */
-function linkToGuide( str, data, hexo, { relativeUrlHelper, isSilentError } ) {
+function linkToGuide( str, data, hexo, { relativeUrlHelper, isSilentError }, onlyHref = false ) {
 	const rgxp = /@link(?:\s+@(\w+))?\s+([^}\s]+)\s*([^}]*)}/;
 	const match = rgxp.exec( str );
 
@@ -328,8 +337,13 @@ function linkToGuide( str, data, hexo, { relativeUrlHelper, isSilentError } ) {
 	}
 
 	const href = relativeUrlHelper( data.path, targetPath );
+	const finalHref = `${ href }${ hash }`;
 
-	return `<a href=${ href }${ hash }>${ linkText }</a>`;
+	if ( onlyHref ) {
+		return finalHref;
+	}
+
+	return `<a href=${ finalHref }>${ linkText }</a>`;
 }
 
 /**
@@ -371,3 +385,10 @@ function getSlug( config, name ) {
 
 	return null;
 }
+
+module.exports = {
+	parseLinks,
+	linkToApi,
+	linkToSdk,
+	linkToGuide
+};