umberto 3.2.2 → 4.0.1

package/CHANGELOG.md

@@ -1,6 +1,31 @@
 Changelog
 =========
 
+## [4.0.1](https://github.com/cksource/umberto/compare/v4.0.0...v4.0.1) (2023-10-16)
+
+### Bug fixes
+
+* Fixed invalid rendering double braces in code snippets. Closes [#1179](https://github.com/cksource/umberto/issues/1179). ([commit](https://github.com/cksource/umberto/commit/68122163660d9e6a3105ac5361cde05c7d4a8a49))
+
+
+## [4.0.0](https://github.com/cksource/umberto/compare/v3.2.2...v4.0.0) (2023-10-10)
+
+### BREAKING CHANGES
+
+* Upgraded the minimal versions of Node.js to `18.0.0` due to the end of LTS.
+
+### Bug fixes
+
+* Added support for perm-link feature on API pages. Closes [#1167](https://github.com/cksource/umberto/issues/1167). ([commit](https://github.com/cksource/umberto/commit/20d167082e126541d3f2867ebebcf57b6c3173f8))
+* Added the `[title]` attribute to the Table of Content and the navigation menu items. Closes [#1175](https://github.com/cksource/umberto/issues/1175). ([commit](https://github.com/cksource/umberto/commit/8f3c15f96864a4e8320d26fb2b0c00746529e06b))
+* Fixed the "See source" button to be clickable when an item does not have a description. Closes [#1172](https://github.com/cksource/umberto/issues/1172). ([commit](https://github.com/cksource/umberto/commit/05b4e3c6893a8d4fdafd5e48c0293a1a50670a35))
+
+### Other changes
+
+* Replaced the hyphen-minus  (`-`) separator with a vertical pipe (`|`) in the generated title of pages. ([commit](https://github.com/cksource/umberto/commit/8bf6a3afb7337d7d816c3a5206eb3088bc1edf29))
+* Updated the required version of Node.js to 18. See [ckeditor/ckeditor5#14924](https://github.com/ckeditor/ckeditor5/issues/14924). ([commit](https://github.com/cksource/umberto/commit/c7ee14ee127ae5b497569a687e731c40fa6378ef))
+
+
 ## [3.2.2](https://github.com/cksource/umberto/compare/v3.2.1...v3.2.2) (2023-08-28)
 
 ### Bug fixes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "umberto",
-  "version": "3.2.2",
+  "version": "4.0.1",
   "description": "CKSource Documentation builder",
   "main": "src/index.js",
   "files": [
@@ -57,8 +57,7 @@
     "webpack": "^5.74.0"
   },
   "engines": {
-    "node": ">=16.0.0",
-    "npm": ">=5.7.1"
+    "node": ">=18.0.0"
   },
   "author": "CKSource (http://cksource.com/)",
   "license": "MIT",

package/scripts/helper/u-toc.js

@@ -39,7 +39,7 @@ hexo.extend.helper.register( 'uToc', ( data, options = {} ) => {
 			.replace( /</g, '&lt;' )
 			.replace( />/g, '&gt;' );
 
-		const newItem = `<li><a href="#${ id }">${ text }</a></li>`;
+		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.

package/src/hexo-manager.js

@@ -52,9 +52,7 @@ class HexoManager {
 			throw new Error( 'Hexo manager is not initialized' );
 		}
 
-		// jscs: disable
 		return this.config.public_dir;
-		// jscs:enable
 	}
 
 	getSourceDir() {
@@ -62,9 +60,7 @@ class HexoManager {
 			throw new Error( 'Hexo manager is not initialized' );
 		}
 
-		// jscs: disable
 		return upath.join( __dirname, '..', this.config.source_dir );
-		// jscs:enable
 	}
 
 	getThemePath() {
@@ -72,9 +68,7 @@ class HexoManager {
 			throw new Error( 'Hexo manager is not initialized' );
 		}
 
-		// jscs: disable
 		return upath.join( __dirname, '../themes', this.config.theme );
-		// jscs:enable
 	}
 
 	/**

package/themes/umberto/layout/_api-docs/api-base.pug

@@ -35,3 +35,8 @@ block content
 
 block navtree
     != navTree
+
+block projectVersion
+    if projectLocals
+        meta( name= 'project-version' content= projectLocals.projectVersion )
+        meta( name= 'project-slug' content= projectLocals.projectSlug )

package/themes/umberto/layout/_mixin/nav-tree-item.pug

@@ -2,7 +2,7 @@ mixin navTreeItem( data )
 	- const _class = page.path === data.path ? 'tree__item__wrapper tree__item__wrapper--active' : 'tree__item__wrapper';
 	- const menuTitle = data[ 'menu-title' ] || uSplitToTitleAndContent( data.content ).title || data.title;
 	li
-		a( href=relative_url( page.path, data.path ) )
+		a( href=relative_url( page.path, data.path ) title=menuTitle )
 			div( class=_class )
 				span( class="tree__item--guide tree__item__text" ) #{ menuTitle }
 				- if( data.shouldDisplayNewIndicator )

package/themes/umberto/layout/_partial/head.pug

@@ -2,7 +2,7 @@ meta( charset='utf-8' )
 meta( name='viewport' content='width=device-width, initial-scale=1' )
 
 - const titleSuffix = page.groupId === 'api-reference' ? page.projectfullname + ' API docs' : page.projectfullname + ' Documentation';
-- const title = page[ 'meta-title' ] ? page[ 'meta-title' ] : page[ 'meta-title-short' ] ? page[ 'meta-title-short' ] + ' - ' + titleSuffix : page.title + ' - ' + titleSuffix;
+- const title = page[ 'meta-title' ] ? page[ 'meta-title' ] : page[ 'meta-title-short' ] ? page[ 'meta-title-short' ] + ' | ' + titleSuffix : page.title + ' | ' + titleSuffix;
 title= title
 
 //- Used for meta tag and for og:*

package/themes/umberto/src/css/_api-content.scss

@@ -18,6 +18,9 @@
 				// To keep vertical align with paragraph.
 				top: 0.2em;
 
+				// To keep "See source" link clickable.
+				z-index: 1;
+
 				// If "See source" exists, we need to add spacing to first paragraph to prevent overlapping text.
 				+ .main-description p:first-child{
 					padding-right: 100px;

package/scripts/filter/before-post-render/escape-special-characters.js

@@ -1,15 +0,0 @@
-/**
- * @license Copyright (c) 2017-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-'use strict';
-
-/**
- * Escape character `{{` and `}}` in markdown sources. See #579.
-*/
-hexo.extend.filter.register( 'before_post_render', page => {
-	page.content = page.content
-		.replace( /\{\{/g, '{% raw %}{{{% endraw %}' )
-		.replace( /(?<!%)\}\}/g, '{% raw %}}}{% endraw %}' );
-} );