umberto 2.1.8 → 2.2.0

package/README.md

@@ -108,6 +108,7 @@ You can also have a look at [CKEditor5](https://github.com/ckeditor/ckeditor5/tr
 | `path` | Path where to look for documentation source files (Markdown files, images etc.). The path is relative to the location of `umberto.json`. |
 | `startPage` | Path to page linked in drop down menu. If there is nothing provided, then `index.html` (from main project directory) is used. |
 | `redirects` | Object where as a key is stored string representing `old-url` and as a value is stored string representing `new-url`. (_Currently redirects are used only in deployment scripts of big-bang docs._) |
+| `googleoptimize` | `domains` - Array of whitelisted domains from which GO can be used; `id` - container ID |
 | `googletagmanager` | `domains` - Array of whitelisted domains from which GA can be used; `gtm` - container ID |
 | `googleanalytics` | `domains` - Array of whitelisted domains from which GA can be used; `config` - options passed to ga('create') method |
 | `feedbackWidget` | `domains` - Array of whitelisted domains from which feedback widget can be used; `apiKey` - unique key for widget |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "umberto",
-  "version": "2.1.8",
+  "version": "2.2.0",
   "description": "CKSource Documentation builder",
   "main": "src/index.js",
   "files": [
@@ -10,13 +10,14 @@
     ".editorconfig",
     ".eslintrc.js",
     "hexo-config.json",
-    "hexo-shim.js"
+    "hexo-shim.js",
+    "scripts-dev/postinstall.js"
   ],
   "dependencies": {
     "@babel/core": "^7.18.10",
     "@babel/polyfill": "^7.12.1",
     "@babel/preset-env": "^7.18.10",
-    "@ckeditor/jsdoc-plugins": "^30.3.5",
+    "@ckeditor/jsdoc-plugins": "^32.0.1",
     "babel-loader": "^8.2.5",
     "chalk": "^4.1.0",
     "cheerio": "^1.0.0-rc.12",
@@ -54,7 +55,9 @@
     "webpack": "^5.74.0"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-dev-env": "^30.3.5",
+    "@ckeditor/ckeditor5-dev-bump-year": "^32.0.1",
+    "@ckeditor/ckeditor5-dev-ci": "^32.0.1",
+    "@ckeditor/ckeditor5-dev-release-tools": "^32.0.1",
     "browser-sync": "^2.27.10",
     "chai": "^4.3.6",
     "chokidar": "^3.5.3",
@@ -71,7 +74,7 @@
     "npm": ">=5.7.1"
   },
   "scripts": {
-    "postinstall": "node ./scripts/postinstall.js",
+    "postinstall": "node ./scripts-dev/postinstall.js",
     "dev:build-single": "node ./scripts-dev/build-single.js",
     "dev:build-multi": "node ./scripts-dev/build-multi.js",
     "dev:serve": "node ./scripts-dev/serve.js",
@@ -101,6 +104,6 @@
     "packages/**"
   ],
   "hexo": {
-    "version": "6.2.0"
+    "version": "6.3.0"
   }
 }

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

@@ -17,6 +17,7 @@ const umbertoVersion = require( '../../../package.json' ).version;
  * @param {String} basePath Project's base path, e.g. 'ckeditor5/1.0.0'.
  * @param {Object} docSearch Algolia's docsearch config.
  * @param {Object} config umberto.json config.
+ * @param {Object} googleoptimize Google Optimize config.
  * @param {Object} googletagmanager Google Tag Manager config.
  * @param {Object} googleanalytics Google Analytics config.
  * @param {Object} feedbackWidget Feedback widget config
@@ -30,6 +31,7 @@ module.exports = ( ctx, {
 	basePath,
 	docSearch = {},
 	config,
+	googleoptimize,
 	googletagmanager,
 	googleanalytics,
 	feedbackWidget,
@@ -93,6 +95,7 @@ module.exports = ( ctx, {
 
 		locals.umbertoVersion = umbertoVersion;
 		locals.disableSearch = disableSearch;
+		locals.googleoptimize = googleoptimize;
 		locals.googletagmanager = googletagmanager;
 		locals.googleanalytics = googleanalytics;
 		locals.feedbackWidget = feedbackWidget;

package/src/index.js

@@ -56,6 +56,7 @@ module.exports = {
 				mainConfig: {
 					projects: [ '.' ],
 					docsearch: pConfig.docsearch,
+					googleoptimize: pConfig.googleoptimize,
 					googletagmanager: pConfig.googletagmanager,
 					googleanalytics: pConfig.googleanalytics,
 					feedbackWidget: pConfig.feedbackWidget,

package/src/tasks/build-documentation.js

@@ -135,6 +135,7 @@ module.exports = options => {
 				dev,
 				docSearch: mainConfig.docsearch,
 				disableSearch: mainConfig.docsearch === false,
+				googleoptimize: mainConfig.googleoptimize,
 				googletagmanager: mainConfig.googletagmanager,
 				googleanalytics: mainConfig.googleanalytics,
 				feedbackWidget: mainConfig.feedbackWidget,
@@ -305,6 +306,7 @@ function buildProjects( rootPath, projectPaths, options = {} ) {
 				extraStyles: options.extraStyles,
 				extraScripts: options.extraScripts,
 				disableSearch: options.disableSearch,
+				googleoptimize: options.googleoptimize,
 				googletagmanager: options.googletagmanager,
 				googleanalytics: options.googleanalytics,
 				feedbackWidget: options.feedbackWidget,
@@ -322,6 +324,7 @@ function buildProjects( rootPath, projectPaths, options = {} ) {
 			extraStyles: options.extraStyles,
 			extraScripts: options.extraScripts,
 			disableSearch: options.disableSearch,
+			googleoptimize: options.googleoptimize,
 			googletagmanager: options.googletagmanager,
 			googleanalytics: options.googleanalytics,
 			feedbackWidget: options.feedbackWidget,
@@ -362,6 +365,7 @@ function buildProjects( rootPath, projectPaths, options = {} ) {
 			basePath,
 			docSearch: options.docSearch,
 			config,
+			googleoptimize: options.googleoptimize,
 			googletagmanager: options.googletagmanager,
 			googleanalytics: options.googleanalytics,
 			feedbackWidget: options.feedbackWidget,
@@ -464,6 +468,7 @@ function buildApis( projectConfigs, options = {} ) {
 					projectSlug: config.slug
 				},
 				disableSearch: options.disableSearch,
+				googleoptimize: options.googleoptimize,
 				googletagmanager: options.googletagmanager,
 				googleanalytics: options.googleanalytics,
 				feedbackWidget: options.feedbackWidget,
@@ -531,6 +536,7 @@ function buildSdks( projectConfigs, options = {} ) {
 				},
 				disableSearch: options.disableSearch,
 				projectsData: basicProjectsData,
+				googleoptimize: options.googleoptimize,
 				googletagmanager: options.googletagmanager,
 				googleanalytics: options.googleanalytics,
 				feedbackWidget: options.feedbackWidget,

package/themes/umberto/layout/_partial/google-optimize.pug

@@ -0,0 +1,15 @@
+if googleoptimize
+
+    // Google Optimize
+    script.
+        if (!{ JSON.stringify(googleoptimize.domains) }.indexOf(location.hostname) !== -1) {
+            (function (w, d, s, i) {
+                var f = d.getElementsByTagName(s)[0],
+                    j = d.createElement(s);
+                j.async = true;
+                j.src = 'https://www.googleoptimize.com/optimize.js?id=' + i;
+                f.parentNode.insertBefore(j, f);
+            })( window, document, 'script', '!{ googleoptimize.id }' );
+        }
+
+    // End Google Optimize

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

@@ -60,7 +60,7 @@ if projectLocals
 if page.isSnippetPage
 	//UMBERTO: SNIPPET: CSS
 
+include google-optimize 
 include google-tag-manager
 include google-analytics
 
-include feedback-widget