docusaurus-preset-shiki-twoslash

v1.1.41

A Docusaurus plugin which adds shiki with optional twoslash-powered code samples For more information about how to use this package see README

Latest version published 2 years ago

License: MIT

NPM

GitHub

Package Health Score

57 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Active

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.1.41	\|	04/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.4	\|	06/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (719)

GitHub Stars: 1.08K
Forks: 53
Contributors: 40

Direct Usage Popularity

The npm package docusaurus-preset-shiki-twoslash receives a total of 719 downloads a week. As such, we scored docusaurus-preset-shiki-twoslash popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package docusaurus-preset-shiki-twoslash, we found that it has been starred 1,078 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 40
Funding: No

With more than 10 contributors for the docusaurus-preset-shiki-twoslash repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like docusaurus-preset-shiki-twoslash is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 58
Open PR: 6
Last Release: 2 years ago
Last Commit: 9 months ago

Further analysis of the maintenance status of docusaurus-preset-shiki-twoslash based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for docusaurus-preset-shiki-twoslash is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 3 years
Dependencies: 3 Direct
Versions: 48
Install Size: 18.5 kB
Dist-tags: 1
# of Files: 10
Maintainers: 3
TS Typings: Yes

docusaurus-preset-shiki-twoslash has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Docusaurus Preset Shiki Twoslash

Sets up markdown code blocks to run through shiki which means it gets the VS Code quality syntax highlighting mixed with the twoslash JavaScript tooling from the TypeScript website.

Setup

Install the dependency: yarn add docusaurus-preset-shiki-twoslash

Include "docusaurus-preset-shiki-twoslash" in the presets section of docusaurus.config.js

  presets: [
 [
   '@docusaurus/preset-classic',
   {
     // ...
   },
 ],
+ [
+     'docusaurus-preset-shiki-twoslash',
+     {
+       themes: ["min-light", "nord"],
+     },
+ ],
],

Set up light/dark mode CSS in src/css/custom.css:

[data-theme="light"] .shiki.nord {
   display: none;
}

[data-theme="dark"] .shiki.min-light {
   display: none;
}

Go read npmjs.com/package/remark-shiki-twoslash to see what is available, this package leaves all the heavy work to that module.

docusaurus-preset-shiki-twoslash dependencies

copy-text-to-clipboard remark-shiki-twoslash typescript

docusaurus-preset-shiki-twoslash development dependencies

@docusaurus/types @types/node

FAQs

What is docusaurus-preset-shiki-twoslash?

A Docusaurus plugin which adds shiki with optional twoslash-powered code samples. Visit Snyk Advisor to see a full health score report for docusaurus-preset-shiki-twoslash, including popularity, security, maintenance & community analysis.

Is docusaurus-preset-shiki-twoslash popular?

The npm package docusaurus-preset-shiki-twoslash receives a total of 719 weekly downloads. As such, docusaurus-preset-shiki-twoslash popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is docusaurus-preset-shiki-twoslash well maintained?

We found indications that docusaurus-preset-shiki-twoslash is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is docusaurus-preset-shiki-twoslash safe to use?

The npm package docusaurus-preset-shiki-twoslash was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 11 November-2024, at 21:06 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP