@wcj/markdown-style
v1.1.3TypeScript
Integrate markdown styles into web components, Markdown CSS styles will not be conflicted.
4.1K/weekUpdated 6 days agoMITUnpacked: 63.9 KB
Published by wcjiang
npm install @wcj/markdown-style
Markdown Style
===
Integrate markdown styles into web components, Markdown CSS styles will not be conflicted. The minimal amount of CSS to replicate the GitHub Markdown style. Support dark-mode/night mode.
Installation
``bash`
npm install --save @wcj/markdown-style
Or load the ES module directly through unpkg
unpkg.com CDN:
`html`
Skypack CDN:
`html`
Usage
Use it in your HTML:
`html`
Markdown HTML
Learn about web components here.
Using it in your React:
`jsx
import React from 'react';
import '@wcj/markdown-style';
function Demo() {
return (
Markdown Style
);
}
`
Convert markdown to html and add markdown style to it:
`html`
\jsx
import React from 'react';
import 'markdown-style';
function Demo() {
return (
Markdown Style
);
}
\`
Support dark-mode/night-mode
By default, the dark-mode is automatically switched according to the system. If you need to switch manually, just set the data-color-mode="dark" parameter for .
`html`
`js`
document.documentElement.setAttribute('data-color-mode', 'dark')
document.documentElement.setAttribute('data-color-mode', 'light')
Set the theme, do not automatically switch with the system:
`html`
Markdown Style
Disable internal theme switching functionality
`html``
Markdown Style
Contributors
As always, thanks to our amazing contributors!
Made with github-action-contributors.
License
Licensed under the MIT License.