Add custom admonition types for performance and test frameworks

Author: thomhurst

docs/docusaurus.config.ts

@@ -21,7 +21,6 @@ const config: Config = {
   deploymentBranch: 'gh-pages',
 
   onBrokenLinks: 'throw',
-  onBrokenMarkdownLinks: 'warn',
 
   // Even if you don't use internationalization, you can use this field to set
   // useful metadata like html lang. For example, if your site is Chinese, you
@@ -61,6 +60,9 @@ const config: Config = {
 
   markdown: {
     mermaid: true,
+    hooks: {
+      onBrokenMarkdownLinks: 'warn',
+    },
   },
   themes: ['@docusaurus/theme-mermaid'],
 

docs/src/theme/Admonition/Types.js

@@ -0,0 +1,44 @@
+import React from 'react';
+import DefaultAdmonitionTypes from '@theme-original/Admonition/Types';
+
+function PerformanceAdmonition(props) {
+  return (
+    <DefaultAdmonitionTypes.tip {...props} title={props.title || 'Performance'}>
+      {props.children}
+    </DefaultAdmonitionTypes.tip>
+  );
+}
+
+function FromXunitAdmonition(props) {
+  return (
+    <DefaultAdmonitionTypes.info {...props} title={props.title || 'Coming from xUnit'}>
+      {props.children}
+    </DefaultAdmonitionTypes.info>
+  );
+}
+
+function FromNunitAdmonition(props) {
+  return (
+    <DefaultAdmonitionTypes.info {...props} title={props.title || 'Coming from NUnit'}>
+      {props.children}
+    </DefaultAdmonitionTypes.info>
+  );
+}
+
+function FromMstestAdmonition(props) {
+  return (
+    <DefaultAdmonitionTypes.info {...props} title={props.title || 'Coming from MSTest'}>
+      {props.children}
+    </DefaultAdmonitionTypes.info>
+  );
+}
+
+const AdmonitionTypes = {
+  ...DefaultAdmonitionTypes,
+  'performance': PerformanceAdmonition,
+  'from-xunit': FromXunitAdmonition,
+  'from-nunit': FromNunitAdmonition,
+  'from-mstest': FromMstestAdmonition,
+};
+
+export default AdmonitionTypes;