@ng-doc/utils 15.13.0 → 16.0.0-beta.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/README.md +7 -7
- package/html/helpers/has-class.d.ts +7 -7
- package/html/helpers/has-link-ancestor.d.ts +6 -6
- package/html/helpers/index.d.ts +3 -3
- package/html/helpers/is-code-node.d.ts +6 -6
- package/html/html-post-processor.d.ts +14 -14
- package/html/plugins/autolink-headings.plugin.d.ts +6 -6
- package/html/plugins/keywords.plugin.d.ts +12 -12
- package/html/plugins/mark-code-blocks.plugin.d.ts +9 -9
- package/html/plugins/mark-elements.plugin.d.ts +6 -6
- package/html/plugins/remove-not-indexable-content.plugin.d.ts +6 -6
- package/html/plugins/slugger.plugin.d.ts +8 -8
- package/html/remove-not-indexable-content.d.ts +5 -5
- package/index.d.ts +2 -2
- package/index.js +15009 -66
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
<!-- PROJECT LOGO -->
|
|
6
6
|
<br />
|
|
7
7
|
<div align="center">
|
|
8
|
-
<a href="https://github.com/
|
|
8
|
+
<a href="https://github.com/ng-doc/ng-doc">
|
|
9
9
|
<img src="https://ng-doc.com/assets/images/ng-doc.svg?raw=true" alt="Logo" height="100px">
|
|
10
10
|
</a>
|
|
11
11
|
|
|
@@ -17,9 +17,9 @@
|
|
|
17
17
|
<a href="https://ng-doc.com/"><strong>Explore the docs »</strong></a>
|
|
18
18
|
<br />
|
|
19
19
|
<br />
|
|
20
|
-
<a href="https://github.com/
|
|
20
|
+
<a href="https://github.com/ng-doc/ng-doc/issues">Report Bug</a>
|
|
21
21
|
·
|
|
22
|
-
<a href="https://github.com/
|
|
22
|
+
<a href="https://github.com/ng-doc/ng-doc/issues">Request Feature</a>
|
|
23
23
|
</p>
|
|
24
24
|
</div>
|
|
25
25
|
|
|
@@ -28,11 +28,11 @@
|
|
|
28
28
|
## About The Project
|
|
29
29
|
|
|
30
30
|
This library is a part of NgDoc project, that uses to create documentation
|
|
31
|
-
for Angular projects, please check our [repo](https://github.com/
|
|
31
|
+
for Angular projects, please check our [repo](https://github.com/ng-doc/ng-doc) for more details.
|
|
32
32
|
|
|
33
33
|
[npm-shield]: https://img.shields.io/npm/v/@ng-doc/builder.svg?style=for-the-badge
|
|
34
34
|
[npm-url]: https://www.npmjs.com/package/@ng-doc/builder
|
|
35
|
-
[license-shield]: https://img.shields.io/github/license/
|
|
35
|
+
[license-shield]: https://img.shields.io/github/license/ng-doc/ng-doc.svg?style=for-the-badge
|
|
36
36
|
[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt
|
|
37
|
-
[build-shield]: https://img.shields.io/github/actions/workflow/status/
|
|
38
|
-
[build-url]: https://github.com/
|
|
37
|
+
[build-shield]: https://img.shields.io/github/actions/workflow/status/ng-doc/ng-doc/release.yml?style=for-the-badge&branch=release
|
|
38
|
+
[build-url]: https://github.com/ng-doc/ng-doc/actions
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { Element } from 'hast';
|
|
2
|
-
/**
|
|
3
|
-
*
|
|
4
|
-
* @param node
|
|
5
|
-
* @param cls
|
|
6
|
-
*/
|
|
7
|
-
export declare function hasClass(node: Element, cls: string): boolean;
|
|
1
|
+
import { Element } from 'hast';
|
|
2
|
+
/**
|
|
3
|
+
*
|
|
4
|
+
* @param node
|
|
5
|
+
* @param cls
|
|
6
|
+
*/
|
|
7
|
+
export declare function hasClass(node: Element, cls: string): boolean;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { Element } from 'hast';
|
|
2
|
-
/**
|
|
3
|
-
*
|
|
4
|
-
* @param ancestors
|
|
5
|
-
*/
|
|
6
|
-
export declare function hasLinkAncestor(ancestors: Element[]): boolean;
|
|
1
|
+
import { Element } from 'hast';
|
|
2
|
+
/**
|
|
3
|
+
*
|
|
4
|
+
* @param ancestors
|
|
5
|
+
*/
|
|
6
|
+
export declare function hasLinkAncestor(ancestors: Element[]): boolean;
|
package/html/helpers/index.d.ts
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
export * from './has-class';
|
|
2
|
-
export * from './has-link-ancestor';
|
|
3
|
-
export * from './is-code-node';
|
|
1
|
+
export * from './has-class';
|
|
2
|
+
export * from './has-link-ancestor';
|
|
3
|
+
export * from './is-code-node';
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { Element } from 'hast';
|
|
2
|
-
/**
|
|
3
|
-
*
|
|
4
|
-
* @param node
|
|
5
|
-
*/
|
|
6
|
-
export declare function isCodeNode(node: Element): boolean;
|
|
1
|
+
import { Element } from 'hast';
|
|
2
|
+
/**
|
|
3
|
+
*
|
|
4
|
+
* @param node
|
|
5
|
+
*/
|
|
6
|
+
export declare function isCodeNode(node: Element): boolean;
|
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
import { NgDocHeading } from '@ng-doc/core';
|
|
2
|
-
import { AddUsedKeyword, GetKeyword } from './plugins/keywords.plugin';
|
|
3
|
-
export interface NgDocHtmlPostProcessorConfig {
|
|
4
|
-
headings?: NgDocHeading[];
|
|
5
|
-
route?: string;
|
|
6
|
-
addUsedKeyword?: AddUsedKeyword;
|
|
7
|
-
getKeyword?: GetKeyword;
|
|
8
|
-
}
|
|
9
|
-
/**
|
|
10
|
-
*
|
|
11
|
-
* @param html
|
|
12
|
-
* @param config
|
|
13
|
-
*/
|
|
14
|
-
export declare function htmlPostProcessor(html: string, config: NgDocHtmlPostProcessorConfig): Promise<string>;
|
|
1
|
+
import { NgDocHeading } from '@ng-doc/core';
|
|
2
|
+
import { AddUsedKeyword, GetKeyword } from './plugins/keywords.plugin';
|
|
3
|
+
export interface NgDocHtmlPostProcessorConfig {
|
|
4
|
+
headings?: NgDocHeading[];
|
|
5
|
+
route?: string;
|
|
6
|
+
addUsedKeyword?: AddUsedKeyword;
|
|
7
|
+
getKeyword?: GetKeyword;
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
*
|
|
11
|
+
* @param html
|
|
12
|
+
* @param config
|
|
13
|
+
*/
|
|
14
|
+
export declare function htmlPostProcessor(html: string, config: NgDocHtmlPostProcessorConfig): Promise<string>;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
/**
|
|
2
|
-
*
|
|
3
|
-
* @param options
|
|
4
|
-
* @param route
|
|
5
|
-
*/
|
|
6
|
-
export default function autolinkHeading(route?: string): any;
|
|
1
|
+
/**
|
|
2
|
+
*
|
|
3
|
+
* @param options
|
|
4
|
+
* @param route
|
|
5
|
+
*/
|
|
6
|
+
export default function autolinkHeading(route?: string): any;
|
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
import { NgDocKeyword } from '@ng-doc/core/interfaces';
|
|
2
|
-
import { Element } from 'hast';
|
|
3
|
-
export type AddUsedKeyword = (keyword: string) => void;
|
|
4
|
-
export type GetKeyword = (keyword: string) => NgDocKeyword | undefined;
|
|
5
|
-
/**
|
|
6
|
-
*
|
|
7
|
-
* @param entityStore
|
|
8
|
-
* @param entity
|
|
9
|
-
* @param addUsedKeyword
|
|
10
|
-
* @param getKeyword
|
|
11
|
-
*/
|
|
12
|
-
export default function keywordsPlugin(addUsedKeyword?: AddUsedKeyword, getKeyword?: GetKeyword): (tree: Element) => void;
|
|
1
|
+
import { NgDocKeyword } from '@ng-doc/core/interfaces';
|
|
2
|
+
import { Element } from 'hast';
|
|
3
|
+
export type AddUsedKeyword = (keyword: string) => void;
|
|
4
|
+
export type GetKeyword = (keyword: string) => NgDocKeyword | undefined;
|
|
5
|
+
/**
|
|
6
|
+
*
|
|
7
|
+
* @param entityStore
|
|
8
|
+
* @param entity
|
|
9
|
+
* @param addUsedKeyword
|
|
10
|
+
* @param getKeyword
|
|
11
|
+
*/
|
|
12
|
+
export default function keywordsPlugin(addUsedKeyword?: AddUsedKeyword, getKeyword?: GetKeyword): (tree: Element) => void;
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Add hljs class to `pre` elements that contain `code` elements
|
|
3
|
-
*
|
|
4
|
-
* We need this to allow customization of the code block style
|
|
5
|
-
*
|
|
6
|
-
* @param tree
|
|
7
|
-
* @param headings
|
|
8
|
-
*/
|
|
9
|
-
export default function markCodeBlocksPlugin(): any;
|
|
1
|
+
/**
|
|
2
|
+
* Add hljs class to `pre` elements that contain `code` elements
|
|
3
|
+
*
|
|
4
|
+
* We need this to allow customization of the code block style
|
|
5
|
+
*
|
|
6
|
+
* @param tree
|
|
7
|
+
* @param headings
|
|
8
|
+
*/
|
|
9
|
+
export default function markCodeBlocksPlugin(): any;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
/**
|
|
2
|
-
*
|
|
3
|
-
* @param tree
|
|
4
|
-
* @param headings
|
|
5
|
-
*/
|
|
6
|
-
export default function markElementsPlugin(): any;
|
|
1
|
+
/**
|
|
2
|
+
*
|
|
3
|
+
* @param tree
|
|
4
|
+
* @param headings
|
|
5
|
+
*/
|
|
6
|
+
export default function markElementsPlugin(): any;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
/**
|
|
2
|
-
*
|
|
3
|
-
* @param tree
|
|
4
|
-
* @param headings
|
|
5
|
-
*/
|
|
6
|
-
export default function removeNotIndexableContentPlugin(): any;
|
|
1
|
+
/**
|
|
2
|
+
*
|
|
3
|
+
* @param tree
|
|
4
|
+
* @param headings
|
|
5
|
+
*/
|
|
6
|
+
export default function removeNotIndexableContentPlugin(): any;
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { NgDocHeading } from '@ng-doc/core';
|
|
2
|
-
import { Root } from 'hast';
|
|
3
|
-
/**
|
|
4
|
-
*
|
|
5
|
-
* @param tree
|
|
6
|
-
* @param headings
|
|
7
|
-
*/
|
|
8
|
-
export default function sluggerPlugin(headings?: NgDocHeading[]): (tree: Root) => void;
|
|
1
|
+
import { NgDocHeading } from '@ng-doc/core';
|
|
2
|
+
import { Root } from 'hast';
|
|
3
|
+
/**
|
|
4
|
+
*
|
|
5
|
+
* @param tree
|
|
6
|
+
* @param headings
|
|
7
|
+
*/
|
|
8
|
+
export default function sluggerPlugin(headings?: NgDocHeading[]): (tree: Root) => void;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
/**
|
|
2
|
-
*
|
|
3
|
-
* @param html
|
|
4
|
-
*/
|
|
5
|
-
export declare function removeNotIndexableContent(html: string): Promise<string>;
|
|
1
|
+
/**
|
|
2
|
+
*
|
|
3
|
+
* @param html
|
|
4
|
+
*/
|
|
5
|
+
export declare function removeNotIndexableContent(html: string): Promise<string>;
|
package/index.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export * from './html/html-post-processor';
|
|
2
|
-
export * from './html/remove-not-indexable-content';
|
|
1
|
+
export * from './html/html-post-processor';
|
|
2
|
+
export * from './html/remove-not-indexable-content';
|