umberto 2.1.1 → 2.1.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "umberto",
-  "version": "2.1.1",
+  "version": "2.1.4",
   "description": "CKSource Documentation builder",
   "main": "src/index.js",
   "files": [

package/scripts/helper/find-main-category-page.js

@@ -0,0 +1,10 @@
+/**
+ * @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const findMainCategoryPage = require( '../utils/findmaincategorypage.js' );
+
+hexo.extend.helper.register( 'findMainCategoryPage', findMainCategoryPage );

package/scripts/utils/findmaincategorypage.js

@@ -0,0 +1,20 @@
+/**
+ * @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+/**
+ * The function returns a `page` object that represents the main landing page for given category.
+ *
+ * @param {String} category
+ * @param {Object} allPages
+ * @param {Array} allPages.data
+ * @returns {*}
+ */
+module.exports = function findMainCategoryPage( category, allPages ) {
+	return allPages.data
+		.filter( page => page.category === category )
+		.find( page => page.shortName === 'index' );
+};

package/src/api-builder/api-builder.js

@@ -439,7 +439,8 @@ module.exports = class ApiBuilder {
 						groups: this._groups,
 						slug: this._projectSlug,
 						customRanking: this._projectConfig.docsearch ? this._projectConfig.docsearch.customRanking : []
-					} )
+					} ),
+					projectVersion: this._projectConfig.version
 				};
 				const view = new HtmlFile(
 					this._tmplCol.renderTemplate(

package/src/helpers/get-docsearch-config.js

@@ -189,7 +189,7 @@ function getTransformDataFns( groups, slug ) {
 		'tags.forEach( function( tag ) {',
 		'hitsGrouped[ tag ] = hits',
 		'.filter( function( h ) {',
-		'return h.tags.includes( tag );',
+		`return h.tags.includes( '${ slug }' ) && h.tags.includes( tag );`,
 		'} )',
 		'.slice( 0, 10 )',
 		'.map( function( item, idx ) {',

package/src/hexo/filter/project-locals.js

@@ -69,6 +69,7 @@ module.exports = ( ctx, {
 				repoUrl: config.repoUrl,
 				og: config.og,
 				projectSlug: config.slug,
+				projectVersion: config.version,
 				navigationShowEmptyCategories
 			};
 		}

package/src/tasks/get-project-config.js

@@ -271,6 +271,11 @@ function validateCategories( category, uniqueIds ) {
 
 	uniqueIds.add( category.id );
 
+	// The "navigationIncludeIndex" option is supported only for top-level categories.
+	if ( typeof category.navigationIncludeIndex !== 'undefined' ) {
+		throw new Error( `The "navigationIncludeIndex" option is supported only for top-level categories. Found in "${ category.id }".` );
+	}
+
 	// Check nested categories only if the value is an array.
 	if ( !isArray( category.categories ) ) {
 		return;

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

@@ -33,8 +33,5 @@ block content
 
     include _partial/functions
 
-    if page.reportIssueWidget
-        include ../_partial/report-issue-widget
-
 block navtree
     != navTree

package/themes/umberto/layout/_api-docs/class.pug

@@ -2,4 +2,9 @@ extends api-base
 include ./_mixin/_api-title
 
 block prepend content
-    +apiTitle( { iconPath: 'assets/' + umbertoVersion + '/img/cog.svg', kind: 'Class' } )
+    +apiTitle( { iconPath: 'assets/' + umbertoVersion + '/img/cog.svg', kind: 'Class' } )
+
+//- Make sure to add the report issue widget at the end of the page.
+block append content
+    if page.reportIssueWidget
+        include ../_partial/report-issue-widget

package/themes/umberto/layout/_api-docs/interface.pug

@@ -3,3 +3,8 @@ include ./_mixin/_api-title
 
 block prepend content
     +apiTitle( { iconPath: 'assets/' + umbertoVersion + '/img/arrows.svg', kind: 'Interface' } )
+
+//- Make sure to add the report issue widget at the end of the page.
+block append content
+    if page.reportIssueWidget
+        include ../_partial/report-issue-widget

package/themes/umberto/layout/_api-docs/mixin.pug

@@ -3,3 +3,8 @@ include ./_mixin/_api-title
 
 block prepend content
     +apiTitle( { iconPath: 'assets/' + umbertoVersion + '/img/cog.svg', kind: 'Mixin' } )
+
+//- Make sure to add the report issue widget at the end of the page.
+block append content
+    if page.reportIssueWidget
+        include ../_partial/report-issue-widget

package/themes/umberto/layout/_api-docs/module.pug

@@ -3,3 +3,8 @@ include ./_mixin/_api-title
 
 block prepend content
     +apiTitle( { iconPath: 'assets/' + umbertoVersion + '/img/box-red.svg', kind: 'Module' } )
+
+//- Make sure to add the report issue widget at the end of the page.
+block append content
+    if page.reportIssueWidget
+        include ../_partial/report-issue-widget

package/themes/umberto/layout/_api-docs/namespace.pug

@@ -3,3 +3,8 @@ include ./_mixin/_api-title
 
 block prepend content
     +apiTitle( { iconPath: 'assets/' + umbertoVersion + '/img/box-brown.svg', kind: 'Namespace' } )
+
+//- Make sure to add the report issue widget at the end of the page.
+block append content
+    if page.reportIssueWidget
+        include ../_partial/report-issue-widget

package/themes/umberto/layout/_api-docs/typedef.pug

@@ -22,3 +22,8 @@ block append content
 
             if isNonEmptyArray( data.see )
                 +related( data.see )
+
+//- Make sure to add the report issue widget at the end of the page.
+block append content
+    if page.reportIssueWidget
+        include ../_partial/report-issue-widget

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

@@ -11,11 +11,15 @@ mixin navTreeLevel( data, isRoot )
 	- const shouldPrintSubTree = dataArr.filter( item => item.title || item.hasDescendentLeaf ).length || projectLocals.navigationShowEmptyCategories
 
 	if isRoot
+		if data.navigationIncludeIndex
+			+navTreeItem( findMainCategoryPage( data.id, site.pages ) )
+
 		each item in dataArr
 			if item.name
 				+navTreeLevel( item, false )
 			else
 				+navTreeItem( item )
+
 	//- We don't want to display empty categories (#523).
 	else if shouldPrintSubTree
 		li

package/themes/umberto/layout/_partial/report-issue-widget.pug

@@ -2,6 +2,7 @@
 - const shortPageUrl = page.path.split( '/' ).slice( 2 ).join( '/' )
 - const githubUrl = new URL( page.reportIssueWidget );
 - githubUrl.searchParams.set( 'title', 'Docs issue report from "' + shortPageUrl + '"' );
+- githubUrl.searchParams.set( 'project-version', projectLocals.projectVersion );
 
 div.info-box.notice.notice__feedback
     p

package/themes/umberto/layout/api.pug

@@ -9,9 +9,11 @@ block content
 
 	!= split.content
 
-	if page.reportIssueWidget
-		include _partial/report-issue-widget
-
 block navtree
 	if projectLocals && projectLocals.apiTree
 		!= projectLocals.apiTree
+
+//- Make sure to add the report issue widget at the end of the page.
+block append content
+	if page.reportIssueWidget
+		include _partial/report-issue-widget

package/themes/umberto/layout/page.pug

@@ -12,6 +12,8 @@ block content
 
 	!= split.content
 
+//- Make sure to add the report issue widget at the end of the page.
+block append content
 	if page.reportIssueWidget
 		include _partial/report-issue-widget