Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add markdown, mdx support to Highlight #188

Merged
merged 2 commits into from
Aug 6, 2020
Merged

Add markdown, mdx support to Highlight #188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
55dec55
Add markdown, mdx support to Highlight
kylesuss Aug 6, 2020
209eddb
Adjust right padding on CodeSnippets to account for copied language
kylesuss Aug 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/components/CodeSnippets.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ const StyledHighlight = styled(Highlight)`
&& pre[class*='language-'] {
background-color: transparent;
padding: 15px 1rem;
padding-right: 4rem;
padding-right: 5rem;
margin: 0;
}
`;
Expand Down
18 changes: 16 additions & 2 deletions src/components/Highlight.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,10 @@ if (typeof document !== 'undefined') {
require('prismjs/components/prism-json');
require('prismjs/components/prism-css');
require('prismjs/components/prism-yaml');
require('prismjs/components/prism-markdown');
}

const languages = ['bash', 'javascript', 'typescript', 'json', 'css', 'yaml'];
const languages = ['bash', 'javascript', 'typescript', 'json', 'css', 'yaml', 'markdown'];

// Prism theme copied from 'prismjs/themes/prism.css.' -- without Webpack, the CSS
// cannot be imported easily and any app which pulls in the design system will
Expand Down Expand Up @@ -52,8 +53,20 @@ const HighlightBlock = styled.div`
color: ${color.darkest};
background: none;
}

.language-markdown .token.title {
color: #dd4a68;
}

.language-markdown .token.table-header {
color: #07a;
}
`;

const languageMap = {
mdx: 'markdown',
};

export class Highlight extends React.Component {
componentDidMount() {
this.highlightCode();
Expand All @@ -69,7 +82,8 @@ export class Highlight extends React.Component {
}

render() {
const { children, language, withHTMLChildren, ...rest } = this.props;
const { children, language: inputLanguage, withHTMLChildren, ...rest } = this.props;
const language = languageMap[inputLanguage] || inputLanguage;
const codeBlock = withHTMLChildren ? (
<div dangerouslySetInnerHTML={{ __html: children }} />
) : (
Expand Down
34 changes: 34 additions & 0 deletions src/components/Highlight.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,29 @@ jobs:

const yamlCodeWithWrappers = `<pre class="language-yaml"><code class="language-yaml">${yamlCode}</code></pre>`;

const markdownCode = `import { Meta, Story, Preview } from '@storybook/addon-docs/blocks';

&#x3C;Meta title="MDX/Checkbox" component={Checkbox} />

# This is a level 1 heading

## This is a level 2 heading

### This is a level 3 heading

#### This is a level 4 heading

This is a paragraph

| Table | Heading |
|-------|---------|
| row | value |

export const test = () => &#x3C;Derp prop="test" />
`;

const markdownCodeWithWrappers = `<pre class="language-markdown"><code class="language-markdown">${markdownCode}</code></pre>`;

export default {
title: 'Design System/Highlight',
component: Highlight,
Expand Down Expand Up @@ -133,6 +156,17 @@ export const YAML = () => (
</>
);

export const Markdown = () => (
<>
<strong>Autoformat</strong>
<Highlight language="markdown">{markdownCode}</Highlight>
<strong>Autoformat w/ MDX Language</strong>
<Highlight language="mdx">{markdownCode}</Highlight>
<strong>Pre-formatted</strong>
<Highlight>{markdownCodeWithWrappers}</Highlight>
</>
);

const SmallContainer = styled.div`
max-width: 300px;
`;
Expand Down