umberto 1.17.0 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.eslintrc.js +9 -1
- package/LICENSE.md +2 -2
- package/README.md +5 -0
- package/hexo-config.json +1 -1
- package/hexo-shim.js +1 -1
- package/package.json +7 -7
- package/scripts/filter/after-post-render/basepath-replacer.js +1 -1
- package/scripts/filter/after-post-render/fix-code-samples.js +1 -1
- package/scripts/filter/after-post-render/gather-guides.js +1 -1
- package/scripts/filter/after-post-render/img-linker.js +1 -1
- package/scripts/filter/after-post-render/import-guide.js +1 -1
- package/scripts/filter/after-post-render/insert-error-codes.js +1 -1
- package/scripts/filter/after-post-render/linker.js +1 -1
- package/scripts/filter/after-post-render/parseicontag.js +1 -1
- package/scripts/filter/after-post-render/process-variables.js +1 -1
- package/scripts/filter/after-post-render/snippets.js +1 -1
- package/scripts/filter/after-post-render/time-end.js +1 -1
- package/scripts/filter/after-post-render/time-start.js +1 -1
- package/scripts/filter/after-post-render/validate-after-render.js +1 -1
- package/scripts/filter/before-post-render/add-project-info-to-page.js +1 -1
- package/scripts/filter/before-post-render/add-repo-url.js +1 -1
- package/scripts/filter/before-post-render/change-output-path.js +1 -1
- package/scripts/filter/before-post-render/escape-special-characters.js +1 -1
- package/scripts/filter/before-post-render/execute-and-insert-function-results.js +1 -1
- package/scripts/filter/before-post-render/infobox.js +1 -1
- package/scripts/filter/before-post-render/insertchangelog.js +1 -1
- package/scripts/filter/before-post-render/replace-macros.js +1 -1
- package/scripts/filter/before-post-render/set-layout.js +1 -1
- package/scripts/filter/before-post-render/validate-page-data.js +1 -1
- package/scripts/helper/get-pages-for-nav-tree.js +1 -1
- package/scripts/helper/mark-empty-categories.js +1 -1
- package/scripts/helper/normalize-badges.js +1 -1
- package/scripts/helper/u-split-to-title-and-content.js +1 -1
- package/scripts/helper/u-toc.js +11 -2
- package/scripts/utils/execute-and-insert-function-results.js +1 -1
- package/scripts/utils/insertchangelog.js +1 -1
- package/scripts/utils/normalizebadges.js +1 -1
- package/scripts/utils/parseicontag.js +1 -1
- package/scripts/utils/parselinks.js +1 -1
- package/scripts/utils/shoulddisplaynewindicator.js +1 -1
- package/scripts/utils/transforminfobox.js +1 -1
- package/src/api-builder/api-builder.js +2 -3
- package/src/api-builder/classes/description-parser.js +1 -1
- package/src/api-builder/classes/doc-data-factory.js +2 -2
- package/src/api-builder/classes/file-name-manager.js +1 -1
- package/src/api-builder/classes/html-file.js +1 -1
- package/src/api-builder/classes/navigation-tree.js +1 -1
- package/src/api-builder/classes/tree-node.js +1 -1
- package/src/data-converter/converters/jsdoc2umberto.js +1 -1
- package/src/data-converter/converters/jsduck2umberto.js +1 -1
- package/src/data-converter/data-collection.js +2 -2
- package/src/data-converter/data-provider.js +1 -1
- package/src/data-converter/doclet-collection.js +2 -2
- package/src/data-converter/middlewares/relation-fixer.js +1 -1
- package/src/helpers/capitalize.js +1 -1
- package/src/helpers/copy-file.js +1 -1
- package/src/helpers/create-filtering-data-attribs.js +1 -1
- package/src/helpers/doc-formats.js +1 -1
- package/src/helpers/escape-longname.js +1 -1
- package/src/helpers/extract-longname.js +1 -1
- package/src/helpers/get-api-infobox-tooltip.js +1 -1
- package/src/helpers/get-docsearch-config.js +3 -4
- package/src/helpers/get-file-patterns-to-process.js +1 -1
- package/src/helpers/get-short-module-path.js +1 -1
- package/src/helpers/github-url.js +1 -1
- package/src/helpers/glob-to-regexp.js +1 -1
- package/src/helpers/html-safe.js +1 -1
- package/src/helpers/is-non-empty-array.js +1 -1
- package/src/helpers/snippets.js +1 -1
- package/src/helpers/split-longname.js +1 -1
- package/src/hexo/filter/extend-config.js +1 -1
- package/src/hexo/filter/project-locals.js +1 -2
- package/src/hexo/get-repo-urls.js +1 -1
- package/src/hexo/helper/get-page-group.js +1 -1
- package/src/hexo/project-globals.js +1 -1
- package/src/hexo-manager.js +1 -1
- package/src/index.js +1 -1
- package/src/sdk-builder/get-sdk-sources.js +1 -1
- package/src/sdk-builder/sdk-builder.js +1 -2
- package/src/tasks/build-api-docs.js +1 -1
- package/src/tasks/build-documentation.js +1 -1
- package/src/tasks/build-sdk.js +1 -1
- package/src/tasks/build-snippets.js +1 -1
- package/src/tasks/cache-files.js +1 -1
- package/src/tasks/compile-sass.js +3 -3
- package/src/tasks/copy-assets.js +1 -1
- package/src/tasks/copy-files.js +1 -1
- package/src/tasks/copy-project-docs.js +1 -1
- package/src/tasks/copy-project-icons.js +1 -1
- package/src/tasks/create-redirect-page.js +1 -1
- package/src/tasks/create-sitemap.js +1 -1
- package/src/tasks/create-sym-links.js +1 -1
- package/src/tasks/execute-hooks.js +1 -1
- package/src/tasks/get-extra-files.js +1 -1
- package/src/tasks/get-hexo-config.js +1 -1
- package/src/tasks/get-main-config.js +1 -1
- package/src/tasks/get-project-config.js +1 -1
- package/src/tasks/macro-replacer.js +1 -1
- package/src/tasks/overwrite-api-guides.js +1 -1
- package/src/tasks/read-doc-sources.js +1 -1
- package/src/tasks/run-webpack.js +1 -1
- package/src/tasks/validate-html-w3c.js +1 -2
- package/src/tasks/validate-links.js +1 -1
- package/src/tasks/watcher.js +1 -1
- package/src/tasks/write-html-files.js +1 -1
- package/src/template/template-collection.js +1 -1
- package/themes/umberto/layout/_api-docs/_partial/api-info-box.pug +1 -1
- package/themes/umberto/layout/_api-docs/_partial/api-subheader.pug +1 -1
- package/themes/umberto/layout/_api-docs/_partial/classes.pug +2 -2
- package/themes/umberto/layout/_api-docs/_partial/config-options.pug +2 -2
- package/themes/umberto/layout/_api-docs/_partial/constants.pug +2 -2
- package/themes/umberto/layout/_api-docs/_partial/description.pug +1 -1
- package/themes/umberto/layout/_api-docs/_partial/events.pug +2 -2
- package/themes/umberto/layout/_api-docs/_partial/filter.pug +1 -1
- package/themes/umberto/layout/_api-docs/_partial/functions.pug +2 -2
- package/themes/umberto/layout/_api-docs/_partial/interfaces.pug +2 -2
- package/themes/umberto/layout/_api-docs/_partial/loading-spinner.pug +2 -0
- package/themes/umberto/layout/_api-docs/_partial/methods.pug +5 -5
- package/themes/umberto/layout/_api-docs/_partial/namespaces.pug +2 -2
- package/themes/umberto/layout/_api-docs/_partial/properties.pug +5 -5
- package/themes/umberto/layout/_api-docs/_partial/typedefs.pug +2 -2
- package/themes/umberto/layout/_api-docs/_partial/types.pug +1 -1
- package/themes/umberto/layout/_api-docs/api-base.pug +2 -0
- package/themes/umberto/layout/index.pug +1 -1
- package/themes/umberto/layout/page.pug +1 -1
- package/themes/umberto/layout/sdk.pug +1 -1
- package/themes/umberto/src/css/_api-content.scss +1 -1
- package/themes/umberto/src/css/_api-info-box.scss +1 -1
- package/themes/umberto/src/css/_api-props-filter.scss +2 -2
- package/themes/umberto/src/css/_api-see-source.scss +1 -1
- package/themes/umberto/src/css/_api-subheader.scss +9 -2
- package/themes/umberto/src/css/_api-tree.scss +1 -1
- package/themes/umberto/src/css/_badge.scss +2 -2
- package/themes/umberto/src/css/_collapsinglist.scss +21 -21
- package/themes/umberto/src/css/_content.scss +3 -3
- package/themes/umberto/src/css/_docsearch.scss +1 -1
- package/themes/umberto/src/css/_dropdown.scss +1 -1
- package/themes/umberto/src/css/_editor-icon.scss +1 -1
- package/themes/umberto/src/css/_feedback-widget.scss +1 -1
- package/themes/umberto/src/css/_footer.scss +2 -2
- package/themes/umberto/src/css/_formatted.scss +6 -6
- package/themes/umberto/src/css/_guide-content.scss +2 -2
- package/themes/umberto/src/css/_guide-sdk-tree.scss +1 -1
- package/themes/umberto/src/css/_loading-spinner.scss +33 -0
- package/themes/umberto/src/css/_main.scss +1 -1
- package/themes/umberto/src/css/_navigation.scss +1 -1
- package/themes/umberto/src/css/_notice.scss +5 -5
- package/themes/umberto/src/css/_print.scss +1 -1
- package/themes/umberto/src/css/_prism.scss +1 -1
- package/themes/umberto/src/css/_rwd-breadcrumbs.scss +1 -1
- package/themes/umberto/src/css/_rwd-menu.scss +1 -1
- package/themes/umberto/src/css/_secondary-navigation.scss +2 -2
- package/themes/umberto/src/css/_theme-dark.scss +1 -1
- package/themes/umberto/src/css/_toggler.scss +3 -3
- package/themes/umberto/src/css/_top.scss +6 -6
- package/themes/umberto/src/css/_tree.scss +2 -2
- package/themes/umberto/src/css/_warning-banner.scss +1 -1
- package/themes/umberto/src/css/components/_lightbox.scss +1 -1
- package/themes/umberto/src/css/helpers/_color.scss +4 -4
- package/themes/umberto/src/css/helpers/_font.scss +2 -2
- package/themes/umberto/src/css/helpers/_globals.scss +3 -3
- package/themes/umberto/src/css/helpers/_reset.scss +1 -1
- package/themes/umberto/src/css/helpers/_spacing.scss +1 -1
- package/themes/umberto/src/css/pages/_sdk.scss +1 -1
- package/themes/umberto/src/css/styles.scss +14 -5
- package/themes/umberto/src/js/_anchors.js +1 -1
- package/themes/umberto/src/js/_apisearch.js +1 -1
- package/themes/umberto/src/js/_apitree.js +1 -1
- package/themes/umberto/src/js/_collapsables.js +40 -16
- package/themes/umberto/src/js/_copymobileapinavigation.js +1 -1
- package/themes/umberto/src/js/_devnames.js +1 -1
- package/themes/umberto/src/js/_dropdowns.js +1 -1
- package/themes/umberto/src/js/_filtering.js +8 -3
- package/themes/umberto/src/js/_imageModal.js +1 -1
- package/themes/umberto/src/js/_pagenavigation.js +1 -1
- package/themes/umberto/src/js/_prism.js +1 -1
- package/themes/umberto/src/js/_rwdmenu.js +1 -1
- package/themes/umberto/src/js/_samplecode.js +1 -1
- package/themes/umberto/src/js/_sidenavigation.js +1 -1
- package/themes/umberto/src/js/_toc.js +1 -1
- package/themes/umberto/src/js/_tooltips.js +1 -1
- package/themes/umberto/src/js/_warningbanner.js +1 -1
- package/themes/umberto/src/js/app.js +1 -1
- package/themes/umberto/src/js/vendor/prism.js +42 -41
package/.eslintrc.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @license Copyright (c) 2017-
|
|
2
|
+
* @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
3
|
* For licensing, see LICENSE.md.
|
|
4
4
|
*/
|
|
5
5
|
|
|
@@ -7,6 +7,14 @@
|
|
|
7
7
|
|
|
8
8
|
module.exports = {
|
|
9
9
|
extends: 'ckeditor5',
|
|
10
|
+
rules: {
|
|
11
|
+
'ckeditor5-rules/license-header': [ 'error', { headerLines: [
|
|
12
|
+
'/**',
|
|
13
|
+
' * @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.',
|
|
14
|
+
' * For licensing, see LICENSE.md.',
|
|
15
|
+
' */'
|
|
16
|
+
] } ]
|
|
17
|
+
},
|
|
10
18
|
env: {
|
|
11
19
|
node: true
|
|
12
20
|
},
|
package/LICENSE.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
Software License Agreement
|
|
2
2
|
==========================
|
|
3
3
|
|
|
4
|
-
Copyright (c) 2017-
|
|
4
|
+
Copyright (c) 2017-2022, [CKSource](http://cksource.com) Holding sp. z o.o. All rights reserved.
|
|
5
5
|
|
|
6
6
|
Licensed under the terms of [MIT License](https://opensource.org/licenses/MIT).
|
|
7
7
|
|
|
@@ -13,4 +13,4 @@ Where not otherwise indicated, all CKEditor content is authored by CKSource engi
|
|
|
13
13
|
Trademarks
|
|
14
14
|
----------
|
|
15
15
|
|
|
16
|
-
**CKEditor** is a trademark of [CKSource](http://cksource.com)
|
|
16
|
+
**CKEditor** is a trademark of [CKSource](http://cksource.com) Holding sp. z o.o. All other brand and product names are trademarks, registered trademarks or service marks of their respective holders.
|
package/README.md
CHANGED
|
@@ -258,6 +258,7 @@ title: Overview [optional]
|
|
|
258
258
|
slug: overview [optional]
|
|
259
259
|
order: 10 [optional]
|
|
260
260
|
toc: false [optional]
|
|
261
|
+
toc-limit: 5 [optional]
|
|
261
262
|
badges: [ premium, ... ] [optional]
|
|
262
263
|
sitenav: false [optional]
|
|
263
264
|
feedback-widget: false [optional]
|
|
@@ -307,6 +308,10 @@ Can be set to sort the guides within the same category. If skipped, guides are s
|
|
|
307
308
|
|
|
308
309
|
If defined and set to `false`, table of contents will not be rendered.
|
|
309
310
|
|
|
311
|
+
#### toc-limit [optional]
|
|
312
|
+
|
|
313
|
+
If defined and set to `0` or greater integer, the table of contents will be limited to the defined depth (e.g. for value `2`, only `<h2>` and `<h3>` headings will be shown in the table of contents). Value `0` is an equivalent of using `toc: false`.
|
|
314
|
+
|
|
310
315
|
#### sitenav [optional]
|
|
311
316
|
|
|
312
317
|
If defined and set to `false`, there will be no left-side navigation and main content will be centered.
|
package/hexo-config.json
CHANGED
package/hexo-shim.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "umberto",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "2.0.1",
|
|
4
4
|
"description": "CKSource Documentation builder",
|
|
5
5
|
"main": "src/index.js",
|
|
6
6
|
"files": [
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
"@babel/core": "^7.10.3",
|
|
17
17
|
"@babel/polyfill": "^7.10.1",
|
|
18
18
|
"@babel/preset-env": "^7.10.3",
|
|
19
|
-
"@ckeditor/jsdoc-plugins": "^
|
|
19
|
+
"@ckeditor/jsdoc-plugins": "^27.1.1",
|
|
20
20
|
"babel-loader": "^8.1.0",
|
|
21
21
|
"chalk": "^4.1.0",
|
|
22
22
|
"cheerio": "^0.22.0",
|
|
@@ -42,23 +42,23 @@
|
|
|
42
42
|
"medium-zoom": "^1.0.5",
|
|
43
43
|
"mkdirp": "^1.0.4",
|
|
44
44
|
"moment": "^2.27.0",
|
|
45
|
-
"node-sass": "^4.14.1",
|
|
46
45
|
"nyc": "15.1.0",
|
|
47
46
|
"pug": "^3.0.0",
|
|
47
|
+
"sass": "^1.43.4",
|
|
48
48
|
"sitemap": "^6.1.6",
|
|
49
49
|
"tippy.js": "^6.3.2",
|
|
50
50
|
"tree-model": "^1.0.7",
|
|
51
51
|
"upath": "^2.0.0",
|
|
52
52
|
"vnu-jar": "^20.5.29",
|
|
53
|
-
"webpack": "^
|
|
53
|
+
"webpack": "^5.58.1"
|
|
54
54
|
},
|
|
55
55
|
"devDependencies": {
|
|
56
|
-
"@ckeditor/ckeditor5-dev-env": "^
|
|
56
|
+
"@ckeditor/ckeditor5-dev-env": "^27.3.0",
|
|
57
57
|
"browser-sync": "^2.26.7",
|
|
58
58
|
"chai": "^4.3.4",
|
|
59
59
|
"chokidar": "^3.4.0",
|
|
60
60
|
"eslint": "^7.3.0",
|
|
61
|
-
"eslint-config-ckeditor5": "^
|
|
61
|
+
"eslint-config-ckeditor5": "^4.0.0",
|
|
62
62
|
"husky": "^4.2.5",
|
|
63
63
|
"lint-staged": "^10.2.11",
|
|
64
64
|
"mocha": "^8.3.2",
|
|
@@ -66,7 +66,7 @@
|
|
|
66
66
|
"sinon": "^10.0.0"
|
|
67
67
|
},
|
|
68
68
|
"engines": {
|
|
69
|
-
"node": ">=
|
|
69
|
+
"node": ">=14.0.0",
|
|
70
70
|
"npm": ">=5.7.1"
|
|
71
71
|
},
|
|
72
72
|
"scripts": {
|
package/scripts/helper/u-toc.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @license Copyright (c) 2017-
|
|
2
|
+
* @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
3
|
* For licensing, see LICENSE.md.
|
|
4
4
|
*/
|
|
5
5
|
|
|
@@ -9,7 +9,16 @@ const cheerio = require( 'cheerio' );
|
|
|
9
9
|
|
|
10
10
|
hexo.extend.helper.register( 'uToc', ( data, options = {} ) => {
|
|
11
11
|
const $ = cheerio.load( data );
|
|
12
|
-
|
|
12
|
+
|
|
13
|
+
let usedHeadings = [ 'h2', 'h3', 'h4', 'h5', 'h6' ];
|
|
14
|
+
|
|
15
|
+
if ( options.tocLimit >= 0 ) {
|
|
16
|
+
usedHeadings = usedHeadings.slice( 0, options.tocLimit );
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
usedHeadings = usedHeadings.join( ',' );
|
|
20
|
+
|
|
21
|
+
const headings = $( usedHeadings )
|
|
13
22
|
.filter( function() {
|
|
14
23
|
return !$( this ).parents( '.live-snippet, .collapsing-list__item' ).length;
|
|
15
24
|
} );
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @license Copyright (c) 2017-
|
|
2
|
+
* @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
3
|
* For licensing, see LICENSE.md.
|
|
4
4
|
*/
|
|
5
5
|
|
|
@@ -48,7 +48,7 @@ module.exports = class ApiBuilder {
|
|
|
48
48
|
this._fileNameManager = new FileNameManager();
|
|
49
49
|
|
|
50
50
|
/**
|
|
51
|
-
* Collection of pug
|
|
51
|
+
* Collection of pug templates.
|
|
52
52
|
* @type {TemplateCollection}
|
|
53
53
|
*/
|
|
54
54
|
this._tmplCol = templateCollection;
|
|
@@ -432,7 +432,6 @@ module.exports = class ApiBuilder {
|
|
|
432
432
|
getLinkToSource: githubUrlUtils.getFullGithubLink.bind( this ),
|
|
433
433
|
docSearchConfig: getDocSearchConfig( this._docSearch, {
|
|
434
434
|
groups: this._groups,
|
|
435
|
-
slug: this._projectSlug,
|
|
436
435
|
customRanking: this._projectConfig.docsearch ? this._projectConfig.docsearch.customRanking : []
|
|
437
436
|
} )
|
|
438
437
|
};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @license Copyright (c) 2017-
|
|
2
|
+
* @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
3
|
* For licensing, see LICENSE.md.
|
|
4
4
|
*/
|
|
5
5
|
|
|
@@ -312,7 +312,7 @@ module.exports = class DocDataFactory {
|
|
|
312
312
|
implements: doclet.implementsNested ? sortLongnamesAlphabetically( doclet.implementsNested ) : [],
|
|
313
313
|
mixes: doclet.mixesNested ? sortLongnamesAlphabetically( doclet.mixesNested ) : [],
|
|
314
314
|
augments: augmentsNested,
|
|
315
|
-
// By default we want to show a link to source. However, those URLs can be
|
|
315
|
+
// By default we want to show a link to source. However, those URLs can be hidden using the `@skipsource` annotation.
|
|
316
316
|
skipSource: doclet.skipSource || false
|
|
317
317
|
} );
|
|
318
318
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @license Copyright (c) 2017-
|
|
3
|
-
*
|
|
2
|
+
* @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md.
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
'use strict';
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @license Copyright (c) 2017-
|
|
3
|
-
*
|
|
2
|
+
* @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md.
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
'use strict';
|
package/src/helpers/copy-file.js
CHANGED