Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@christianmurphy/react-remark
Advanced tools
Readme
react-remark offers a React hook and React component based way of rendering markdown into React using remark
npm
npm install --save @christianmurphy/react-remark
yarn
yarn add @christianmurphy/react-remark
import React from 'react';
import { useRemark } from '@christianmurphy/react-remark';
const ExampleComponent = () => {
const [reactContent, setMarkdownSource] = useRemark();
setMarkdownSource('# markdown header');
return reactContent;
};
export default ExampleComponent;
import React from 'react';
import { useRemark } from '@christianmurphy/react-remark';
const ExampleComponent = () => {
const [reactContent, setMarkdownSource] = useRemark();
return (
<>
<input
type="text"
onChange={({ currentTarget }) => setMarkdownSource(currentTarget.value)}
/>
{reactContent}
</>
);
};
export default ExampleComponent;
More examples of usage as hook in storybook.
import React, { useState } from 'react';
import { Remark } from '@christianmurphy/react-remark';
const ExampleComponent = () => (
<Remark>{`
# header
1. ordered
2. list
`}</Remark>
);
export default ExampleComponent;
import React, { useState } from 'react';
import { Remark } from '@christianmurphy/react-remark';
const ExampleComponent = () => {
const [markdownSource, setMarkdownSource] = useState('');
return (
<>
<input
type="text"
onChange={({ currentTarget }) => setMarkdownSource(currentTarget.value)}
/>
<Remark>{markdownSource}</Remark>
</>
);
};
export default ExampleComponent;
More examples of usage as component in storybook.
A set of runnable examples are provided through storybook at https://christianmurphy.github.io/react-remark. The source for the story files can be found in /stories.
react-remark
+---------------------------------------------------------------------------------------------------------------------------------------------+
| |
| +----------+ +----------------+ +---------------+ +----------------+ +--------------+ |
| | | | | | | | | | | |
| -markdown->+ remark +-mdast->+ remark plugins +-mdast->+ remark-rehype +-hast->+ rehype plugins +-hast->+ rehype-react +-react elements-> |
| | | | | | | | | | | |
| +----------+ +----------------+ +---------------+ +----------------+ +--------------+ |
| |
+---------------------------------------------------------------------------------------------------------------------------------------------+
relevant links: markdown, remark, mdast, remark plugins, remark-rehype, hast, rehype plugins, rehype-react
remarkParseOptions
(Object) - configure how Markdown is parsed, same as remark-parse
optionsremarkPlugins
(Array) - remark plugins or custom plugins to transform markdown content before it is translated to HTML (hast)remarkToRehypeOptions
(Object) - configure how Markdown (mdast) is translated into HTML (hast), same as remark-rehype
optionsrehypePlugins
(Array) - rehype plugins or custom plugins to transform HTML (hast) before it is translated to React elements.rehypeReactOptions
(Object) - configure how HTML (hast) is translated into React elements, same as rehype-react
optionsimport React, { Fragment } from 'react';
import { useRemark } from '@christianmurphy/react-remark';
import remarkGemoji from 'remark-gemoji';
import rehypeAutoLinkHeadings from 'rehype-autolink-headings';
// ...
const [reactContent, setMarkdownSource] = useRemark({
remarkParseOptions: { commonmark: true },
remarkPlugins: [remarkGemoji],
remarkToRehypeOptions: { commonmark: true },
rehypePlugins: [rehypeAutoLinkHeadings],
rehypeReactOptions: {
components: {
p: props => <p className="custom-paragraph" {...props} />,
},
},
});
import React, { Fragment } from 'react';
import { useRemark } from '@christianmurphy/react-remark';
import remarkGemoji from 'remark-gemoji';
import rehypeAutoLinkHeadings from 'rehype-autolink-headings';
// ...
<Remark
remarkParseOptions={{ commonmark: true }}
remarkPlugins={[remarkGemoji]}
remarkToRehypeOptions={{ commonmark: true }}
rehypePlugins={[rehypeAutoLinkHeadings]}
rehypeReactOptions={{
components: {
p: props => <p className="custom-paragraph" {...props} />,
},
}}
>
{markdownSource}
</Remark>;
FAQs
Renders Markdown as React components
The npm package @christianmurphy/react-remark receives a total of 2 weekly downloads. As such, @christianmurphy/react-remark popularity was classified as not popular.
We found that @christianmurphy/react-remark demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.