@microflash/remarkability
Advanced tools
A compact CSS library for a pleasant reading experience on the web
— A compact CSS library for a pleasant reading experience on the web
Remarkability provides beautiful and accessible styles for the content generated by the rich-text editors in a CMS or from a markdown file. It comes with sensible defaults that can be customized using Sass.
Add to your project with NPM or Yarn.
npm install @microflash/remarkability
yarn add @microflash/remarkability
This is the recommended way if you want to customize Remarkability using Sass.
Add one of the following <link> elements in the <head> of your HTML document.
<link rel="stylesheet" href="https://unpkg.com/@microflash/remarkability">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@microflash/remarkability">
By default, these CDNs will serve the latest published version. Refer to the unpkg / jsDelivr docs for other possible ways to get Remarkability.
You can also download the latest version or browse the previous releases on GitHub.
Just add .remarkability class to your container to style the elements within.
<article class="remarkability">
<!-- HTML content -->
</article>
By default, Remarkability inherits colors and typography from the parent element but you can customize this behavior with Sass.
With v1.0.0, Remarkability deprecated the global variant. If needed, you can still build it by setting
$rootvariable tobodyusing Sass.
With v1.1.0, Remarkability provides you the flexibility to import what you need; you may choose to import the entire remarkability.scss file or pick the specific parts. The following parts are available for you to import individually.
@use 'node_modules/@microflash/remarkability/scss/variables';
@use 'node_modules/@microflash/remarkability/scss/root';
@use 'node_modules/@microflash/remarkability/scss/all';
@use 'node_modules/@microflash/remarkability/scss/inline';
@use 'node_modules/@microflash/remarkability/scss/media';
@use 'node_modules/@microflash/remarkability/scss/block';
@use 'node_modules/@microflash/remarkability/scss/headings';
@use 'node_modules/@microflash/remarkability/scss/lists';
@use 'node_modules/@microflash/remarkability/scss/form';
@use 'node_modules/@microflash/remarkability/scss/blockquote';
@use 'node_modules/@microflash/remarkability/scss/code';
@use 'node_modules/@microflash/remarkability/scss/table';
For more details and examples, check out the docs.
yarn start to bring up the documentation site which contains an example page.yarn dist to generate a CSS build.yarn docs to generate the static version of the documentation.Licensed under MIT.
Remarkability is built with the generous contributions from the open-source community. It would not have been possible without wysiwyg.css by Jeremy Thomas, github-markdown-css by Sindre Sorhus and the invaluable references on MDN. The typeface used in the logo is Maragsâ Display by John David Maza. The icons are from Octicons, a part of GitHub's Primer design system.
FAQs
A compact CSS library for a pleasant reading experience on the web
The npm package @microflash/remarkability receives a total of 3 weekly downloads. As such, @microflash/remarkability popularity was classified as not popular.
We found that @microflash/remarkability 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
Socket and Seal Security collaborate to fix a critical npm overrides bug, resolving a three-year security issue in the JavaScript ecosystem's most popular package manager.
Security News
TypeScript is porting its compiler to Go, delivering 10x faster builds, lower memory usage, and improved editor performance for a smoother developer experience.
Research
Security News
The Socket Research Team has discovered six new malicious npm packages linked to North Korea’s Lazarus Group, designed to steal credentials and deploy backdoors.