chore: Make docstrings MDX compatible

Signed-off-by: Johan Haals <johan.haals@gmail.com>

.changeset/curvy-weeks-matter.md

@@ -0,0 +1,8 @@
+---
+'@backstage/backend-common': patch
+'@backstage/catalog-model': patch
+'@backstage/core-components': patch
+'@backstage/plugin-techdocs-react': patch
+---
+
+Updated docstring to be MDX compatible.

packages/backend-common/src/reading/FetchUrlReader.ts

@@ -39,8 +39,8 @@ export class FetchUrlReader implements UrlReader {
    * targets to allow, containing the following fields:
    *
    * `host`:
-   *   Either full hostnames to match, or subdomain wildcard matchers with a leading `*`.
-   *   For example `example.com` and `*.example.com` are valid values, `prod.*.example.com` is not.
+   *   Either full hostnames to match, or subdomain wildcard matchers with a leading '*'.
+   *   For example 'example.com' and '*.example.com' are valid values, 'prod.*.example.com' is not.
    *
    * `paths`:
    *   An optional list of paths which are allowed. If the list is omitted all paths are allowed.

packages/catalog-model/src/validation/CommonValidatorFunctions.ts

@@ -24,7 +24,7 @@ import lodash from 'lodash';
  */
 export class CommonValidatorFunctions {
   /**
-   * Checks that the value is on the form <suffix> or <prefix><separator><suffix>, and validates
+   * Checks that the value is on the form `<suffix>` or `<prefix><separator><suffix>`, and validates
    * those parts separately.
    *
    * @param value - The value to check

packages/core-components/src/components/DependencyGraph/DependencyGraph.tsx

@@ -40,7 +40,7 @@ import { ARROW_MARKER_ID } from './constants';
  *
  * @public
  * @remarks
- * <NodeData> and <EdgeData> are useful when rendering custom or edge labels
+ * `<NodeData>` and `<EdgeData>` are useful when rendering custom or edge labels
  */
 export interface DependencyGraphProps<NodeData, EdgeData>
   extends React.SVGProps<SVGSVGElement> {

packages/core-components/src/layout/ItemCard/ItemCardHeader.tsx

@@ -64,7 +64,7 @@ export type ItemCardHeaderProps = Partial<WithStyles<typeof styles>> & {
  * A simple card header, rendering a default look for "item cards" - cards that
  * are arranged in a grid for users to select among several options.
  *
- * This component expects to be placed within a MUI <CardMedia>.
+ * This component expects to be placed within a MUI `<CardMedia>`.
  *
  * Styles for the header can be overridden using the `classes` prop, e.g.:
  *

plugins/techdocs-react/src/addons.tsx

@@ -30,7 +30,7 @@ import { TechDocsAddonLocations, TechDocsAddonOptions } from './types';
 export const TECHDOCS_ADDONS_KEY = 'techdocs.addons.addon.v1';
 
 /**
- * Marks the <TechDocsAddons> registry component.
+ * Marks the `<TechDocsAddons>` registry component.
  * @public
  */
 export const TECHDOCS_ADDONS_WRAPPER_KEY = 'techdocs.addons.wrapper.v1';