escape cell in docs via a util function

mui · Jul 24, 2018 · ccebe58 · ccebe58
1 parent 1c2fef5
commit ccebe58
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/docs/src/modules/utils/generateMarkdown.js b/docs/src/modules/utils/generateMarkdown.js
@@ -248,7 +248,7 @@ function generateClasses(reactAPI) {
       .map(
         className =>
           `| <span class="prop-name">${className}</span> | ${
-            reactAPI.styles.descriptions[className] ? reactAPI.styles.descriptions[className] : ''
+            reactAPI.styles.descriptions[className] ? escapeCell(reactAPI.styles.descriptions[className]) : ''
           }`,
       )
       .join('\n');

diff --git a/pages/api/button.md b/pages/api/button.md
@@ -47,18 +47,18 @@ This property accepts the following keys:
 | <span class="prop-name">flatPrimary</span> | Styles applied to the root element for backwards compatibility with legacy variant naming.
 | <span class="prop-name">flatSecondary</span> | Styles applied to the root element for backwards compatibility with legacy variant naming.
 | <span class="prop-name">outlined</span> | Styles applied to the root element if `variant="outlined"`.
-| <span class="prop-name">contained</span> | Styles applied to the root element if `variant="[contained \| fab]"`.
-| <span class="prop-name">containedPrimary</span> | Styles applied to the root element if `variant="[contained \| fab]"` and `color="primary"`.
-| <span class="prop-name">containedSecondary</span> | Styles applied to the root element if `variant="[contained \| fab]"` and `color="secondary"`.
+| <span class="prop-name">contained</span> | Styles applied to the root element if `variant="[contained &#124; fab]"`.
+| <span class="prop-name">containedPrimary</span> | Styles applied to the root element if `variant="[contained &#124; fab&#124;"` and `color="primary"`.
+| <span class="prop-name">containedSecondary</span> | Styles applied to the root element if `variant="[contained &#124; fab]"` and `color="secondary"`.
 | <span class="prop-name">raised</span> | Styles applied to the root element for backwards compatibility with legacy variant naming.
 | <span class="prop-name">raisedPrimary</span> | Styles applied to the root element for backwards compatibility with legacy variant naming.
 | <span class="prop-name">raisedSecondary</span> | Styles applied to the root element for backwards compatibility with legacy variant naming.
-| <span class="prop-name">fab</span> | Styles applied to the root element if `variant="[fab \| extendedFab]"`.
+| <span class="prop-name">fab</span> | Styles applied to the root element if `variant="[fab &#124; extendedFab]"`.
 | <span class="prop-name">extendedFab</span> | Styles applied to the root element if `variant="extendedFab"`.
 | <span class="prop-name">focusVisible</span> | Styles applied to the ButtonBase root element if the button is keyboard focused.
 | <span class="prop-name">disabled</span> | Styles applied to the root element if `disabled={true}`.
 | <span class="prop-name">colorInherit</span> | Styles applied to the root element if `color="inherit"`.
-| <span class="prop-name">mini</span> | Styles applied to the root element if `size="mini"` & `variant="[fab \| extendedFab]"`.
+| <span class="prop-name">mini</span> | Styles applied to the root element if `size="mini"` & `variant="[fab &#124; extendedFab]"`.
 | <span class="prop-name">sizeSmall</span> | Styles applied to the root element if `size="small"`.
 | <span class="prop-name">sizeLarge</span> | Styles applied to the root element if `size="large"`.
 | <span class="prop-name">fullWidth</span> | Styles applied to the root element if `fullWidth={true}`.