A next-generation tool to create blazing-fast documentation sites
API
created:3/5/2021
updated:3/5/2021
loc
23
comments
52%
passed
4
coverage
100%

Markdown

avatar of atanasster
@component-controls/components
3.15.0

Markdown display component to compile and display markdown at run-time. Uses markdown-to-jsx internally.

import { Markdown } from '@component-controls/components';

Overview

Header H1

Header H2

Header H3

Header H4

Header H5

some text

@theme-ui
Name
Description
Default
children

the markdown source code is passed as a children pro.

string & ReactNode
-
components

components to customize the markdown display.

{ [key: string]: ComponentOverride<any, any>; a?: ComponentOverride<any, any>; br?: ComponentOverride<any, any> | undefined; ... 28 more ...; ul?: ComponentOverride<...> | undefined; } | undefined
-

Commits

Date
Author
Commit Message
7/1/2021

atanasster

avatar of atanasster
fix: pass sx prop to Markdown
2/17/2021

atanasster

avatar of atanasster
feat: components history and catalog
6/8/2020

atanasster

avatar of atanasster
chore: mdx components styling
4/16/2020

atanasster

avatar of atanasster
feat: added theme, components for PageContainer
3/20/2020

atanasster

avatar of atanasster
docs: update docs for Markdown and Popover
3/20/2020

atanasster

avatar of atanasster
docs: collapsible update
3/9/2020

atanasster

avatar of atanasster
docs: update stories, readme
3/9/2020

atanasster

avatar of atanasster
feat: syntahighlighter and markdown code format
3/8/2020

atanasster

avatar of atanasster
chore: move components
9 commits
package
imports
peer
MarkdownToJSXMarkdownOptions
react
^17.0.1
FC
*
theme-ui
^0.8.4
jsx
file
imports
"./MarkdownComponents"
markdownComponents

Stories

Image

integrated in storybook