{"repo":"HPouyanmehr/mui-markdown","free":true,"listed":false,"github":"https://github.com/HPouyanmehr/mui-markdown","clone":"git clone https://github.com/HPouyanmehr/mui-markdown.git","description":"mui-markdown helps you render MD/MDX files with MUI components.","language":"TypeScript","stars":88,"topics":["markdown","mdx","react"],"license":"MIT","category":"productivity","readme_excerpt":"MUI-Markdown About mui-markdown uses markdown-to-jsx and MUI(formerly material-ui) to help you render MD/MDX files with MUI components. Using mui-markdown : - Markdown components will adapt to theme automatically - Optional Syntax Highlight Support using prism-react-renderer - Optional Diagrams Support using mermaid - Optional Math Support using katex - Table of Contents extraction with extractHeadings - GFM task lists rendered with MUI Checkbox and native footnote support Table of Contents - User Guide - Installation - Usage - Props - Overrides - Options - Code Wrapper Styles - Syntax Highlight - Enhanced Code Block Features - Diagram Support - Math Support - Table of Contents Extraction - NextJS - Use with useMDXComponents User Guide Installation Note: mui-markdown v3 requires markdown-to-jsx v9 or newer as a peer dependency. See the CHANGELOG for migration notes if you're upgrading from v2. Usage The example below will render the h1 tag using MUI Typography component. Props Props available for MuiMarkdown component: Name Type Default Optional or Mandatory --------------------------- --------------------------------- ---------------- --------------------- key React.key - optional children string - optional overrides\\ MarkdownToJSX.Overrides defaultOverrides optional options\\ MarkdownToJSX.Options - optional codeWrapperStyles CSSProperties - optional prismTheme PrismTheme vsDark optional Highlight HighlightComponent - optional customTableScrollbar boolean false optional hide","default_branch":null,"files":null,"tree":[],"storefront":"/r/HPouyanmehr","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/HPouyanmehr/mui-markdown/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}