build: escape Markdown special characters

Author: Planeshifter

lib/node_modules/@stdlib/_tools/remark/plugins/remark-stdlib-related/lib/escape_markdown.js

@@ -0,0 +1,59 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2023 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var replace = require( '@stdlib/string/replace' );
+
+
+// VARIABLES //
+
+var RE_MARKDOWN_CHARS = /[\\`*_[#!~|]/g;
+
+
+// MAIN //
+
+/**
+* Escapes Markdown special characters in a string.
+*
+* ## Notes
+*
+* -   This function escapes characters that have special meanings in Markdown, such as #, *, _, ~, etc., by prefixing them with a backslash.
+*
+* @private
+* @param {string} str - string to be escaped
+* @returns {string} escaped string
+*
+* @example
+* var out = escapeMarkdown( 'Returns [index, value] pairs.' );
+* // returns 'Returns \[index, value] pairs.'
+*
+* @example
+* var out = escapeMarkdown( 'Calculates x * y * z.' );
+* // returns 'Calculates x \* y \* z.'
+*/
+function escapeMarkdown( str ) {
+	return replace( str, RE_MARKDOWN_CHARS, '\\$&' );
+}
+
+
+// EXPORTS //
+
+module.exports = escapeMarkdown;

lib/node_modules/@stdlib/_tools/remark/plugins/remark-stdlib-related/lib/transformer.js

@@ -28,6 +28,7 @@ var pkg2related = require( '@stdlib/namespace/pkg2related' );
 var uncapitalizeDescription = require( '@stdlib/_tools/utils/uncapitalize-pkg-description' );
 var format = require( '@stdlib/string/format' );
 var readJSON = require( '@stdlib/fs/read-json' ).sync;
+var escapeMarkdown = require( './escape_markdown.js' );
 
 
 // VARIABLES //
@@ -136,6 +137,7 @@ function transformer( tree, file ) {
 					throw meta;
 				}
 				description = uncapitalizeDescription( meta.description );
+				description = escapeMarkdown( description );
 				content += '-   <span class="package-name">[`'+related[ i ]+'`]['+related[ i ]+']</span>';
 				content += '<span class="delimiter">: </span>';
 				content += '<span class="description">' + description + '</span>';