docsify
Version:
A magical documentation generator.
50 lines • 1.61 kB
TypeScript
/**
* Converts a colon formatted string to a object with properties.
*
* This is process a provided string and look for any tokens in the format
* of `:name[=value]` and then convert it to a object and return.
* An example of this is ':include :type=code :fragment=demo' is taken and
* then converted to:
*
* ```
* {
* include: '',
* type: 'code',
* fragment: 'demo'
* }
* ```
*
* @param {string} str The string to parse.
*
* @return {{str: string, config: Record<string, string | string[]>}} The original string formatted, and parsed object, { str, config }.
*/
export function getAndRemoveConfig(str?: string): {
str: string;
config: Record<string, string | string[]>;
};
/**
* Remove the <a> tag from sidebar when the header with link, details see issue 1069
* @param {string} str The string to deal with.
*
* @return {string} The string after delete the <a> element.
*/
export function removeAtag(str?: string): string;
/**
* Remove the docsifyIgnore configs and return the str
* @param {string} content The string to deal with.
*
* @return {{content: string, ignoreAllSubs: boolean, ignoreSubHeading: boolean}} The string after delete the docsifyIgnore configs, and whether to ignore some or all.
*/
export function getAndRemoveDocsifyIgnoreConfig(content?: string): {
content: string;
ignoreAllSubs: boolean;
ignoreSubHeading: boolean;
};
/**
* Escape HTML special characters in a string to prevent XSS attacks.
*
* @param string
* @returns {string}
*/
export function escapeHtml(string: any): string;
//# sourceMappingURL=utils.d.ts.map