Package Health Score

64 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Active

Explore Similar Packages

Security

No known security issues

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

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
2.22.2	\|	12/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.21.3	\|	07/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.20.6	\|	02/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.9	\|	03/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Yes

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 (19)

GitHub Stars: 400
Forks: 289
Contributors: 90

Direct Usage Popularity

The npm package remark-jargon receives a total of 19 downloads a week. As such, we scored remark-jargon popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package remark-jargon, we found that it has been starred 400 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: Yes
Contributors: 90
Funding: Yes

With more than 10 contributors for the remark-jargon repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 72
Open PR: 40
Last Release: 2 years ago
Last Commit: 12 days ago

Further analysis of the maintenance status of remark-jargon 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 remark-jargon 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: >=14.0.0

Age: 6 years
Dependencies: 1 Direct
Versions: 183
Install Size: 53.8 kB
Dist-tags: 2
# of Files: 7
Maintainers: 1
TS Typings: No

remark-jargon 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

remark-jargon

A Remark plugin for jargon terms

🚨🚨 This packages is deprecated 🚨🚨

This package will not be part of FreeSewing v3. Please use rehype-jargon instead.

About

This Remark plugin allows you to use jargon in your markdown/mdx content and use a centrally managed file of jargon terms and their definitions.

An example of this plugin being used on freesewing.org

Install

To install this plugin, run:

npm install --save remark-jargon

Getting started

> Tip: See https://github.com/joostdecock/remark-jargon-example for a minimal repository that uses this plugin

Create your jargon file

This plugin requires a jargon file with terms defenitions. For example:

module.exports = {
  remark: "<b>remark</b> is a markdown processor powered by plugins. See <a href="https://remark.js.org/">remark.js.org</a>.",
  freesewing: "<b>FreeSewing</b> is an open source platform for made-to-measure sewing patterns. See <a href="https://freesewing.org/">freesewing.org</a>"
}

Import the plugin

Now import the plugin, and pass it your jargon:

var remark = require('remark')
var html = require('remark-html')
var plugin = require('remark-jargon')
var jargon = require('./jargon.js')

remark()
  .use(html)
  .use(plugin, { jargon: jargon })
  .process('This is a plugin for _remark_ originally written for _freesewing_.', function (err, file) {
    console.log(String(file))
  })

> Note > > This plugin will only add markup to your jargon if you emphasize it.

Style your jargon

You will need to add CSS to style your jargon properly, and hide the definition by default. Below is an example to get you started:

// Add a dashed line under jargon terms
.jargon-term {
  text-decoration: underline dotted #228be6
}
// Add a question mark behind/above jargon terms
.jargon-term::after {
  content: "?";
  font-weight: bold;
  display: inline-block;
  transform: translate(0, -0.5em);
  font-size: 75%;
  color: #228be6;
  margin-left: 3px;
}
// Hover behavior for the therm itself
.jargon-term:hover {
  position: relative;
  text-decoration: none;
  cursor: help;
}
// Hide info by default
.jargon-term .jargon-info {
  display: none
}
// Show info on hover
.jargon-term:hover .jargon-info {
  display: block;
  position: absolute;
  top: 1.5em;
  left: 0;
  background: #F8F8F8;
  border: 1px solid #DCDCDC;
  padding: 1rem;
  border-radius: 4px;
  font-size: 90%;
  min-width: 250px;
  max-width: 450px;
  z-index: 1;
}

Tips for using jargon

Lowercase your terms in the jargon file

When looking for terms to match, we lowercase the term your emphazised. So in the jargon file, you should use msf, but in your text, you can use MSF, Msf, or msf.

If you use HTML, only use inline elements

Your jargon term definition can contain HTML, but only inline elements. Typically, you will want to stick to:

Making things bold
Inserting links

Getting help

This plugin is written by/for FreeSewing. For help or feedback, please stop by the FreeSewing chat room or create an issue.

Use with Gatsby

Please see gatsby-remark-jargon for info and instructions on how to use this plugin with Gatsby.

> #### Note: this is the last v2 minor release > > We'll be moving to a new major version (v3) so this is the last minor release. > We'll continue to support this while we work on v3, and backport important fixes. > > Once v3 is out, we'll drop official support for v2.

What am I looking at? 🤔

This repository is our monorepo holding all our NPM designs, plugins, other NPM packages, and (web)sites.

This folder holds: remark-jargon

If you're not entirely sure what to do or how to start, type this command:

npm run tips

> If you don't want to set up a dev environment, you can run it in your browser: > > > > We recommend that you fork our repository and then > put `gitpod.io/# to start up a browser-based dev environment of your own.

About FreeSewing 💀

Where the world of makers and developers collide, that's where you'll find FreeSewing.

If you're a maker, checkout freesewing.org where you can generate our sewing patterns adapted to your measurements.

If you're a developer, our documentation is on freesewing.dev. Our core library is a batteries-included toolbox for parametric design of sewing patterns. But we also provide a range of plugins that further extend the functionality of the platform.

If you have NodeJS installed, you can try it right now by running:

npx create-freesewing-pattern

Or, consult our getting started guides for Linux, MacOS, or Windows.

We also have a pattern design tutorial that walks you through your first parametric design, and a friendly community with people who can help you when you get stuck.

Support FreeSewing: Become a patron 🥰

FreeSewing is an open source project run by a community, and financially supported by our patrons.

If you feel what we do is worthwhile, and you can spend a few coind without hardship, then you should join us and become a patron.

Links 👩‍💻

💻 Makers website: freesewing.org
💻 Developers website: freesewing.dev
💬 Chat: On Discord via discord.freesewing.org
✅ Todo list/Kanban board: On Github via todo.freesewing.org
🐦 Twitter: @freesewing_org
📷 Instagram: @freesewing_org

License: MIT 🤓

Where to get help 🤯

Our chatrooms on Discord are the best place to ask questions, share your feedback, or just hang out.

If you want to report a problem, please create an issue.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{Adam Tomkins} 📖	_{Alexandre Ignjatovic} 💻	_AlfaLyr 💻 🔌 🎨	_{Andrew James} 📖	_Anneke 📖 🌍	_{Annie Kao} 📖	_Anternative 📖
_Anthony 💬	_{Ari Grayzel-student} 💻	_BenJamesBen 💻 📖	_{Cameron Dubas} 📖	_{Carsten Biebricher} 📖	_{Cathy Zoller} 📖	_{Chantal Lapointe} 🌍
_{Damien PIQUET} 💻	_{Darigov Research} 📖 🤔	_{Elena FdR} 📖 📝	_{Emmanuel Nyachoke} 💻 📖	_{Enoch Riese} 💻	_EvEkSwed 🌍	_{Fantastik-Maman} 🌍
_{Forrest O.} 📖	_Frédéric 🌍	_{Glenn Matthews} 📖	_{Greg Sadetsky} 📖	_{Igor Couto} 🐛	_{Ikko Ashimine} 📖	_Irapeke 🌍
_{Jacek Sawoszczuk} 📖	_{Jason Williams} 📖	_{Jeremy Jackson} 💻	_{Joe Schofield} 📖	_Joebidido 🌍	_{Joost De Cock} 🚧	_{Josh Essman} 📖
_Kake 📖	_{Kapunahele Wong} 📖	_Karen 📖 📋	_{Katie McGinley} 📖	_{Kieran Klaassen} 💻	_Kittycatou 🌍	_Kris 📖
_{Kristin Ruben} 💻	_Loudepeuter 🌍	_Lucian 📋	_Marcus 🌍	_{Martin Tribo} 📖	_{Nadege Michel} ⚠️ 📖	_Natalia 💻 🎨 📝
_{Nathan Yergler} 📖	_{Nick Dower} 📖 💻 🐛	_{Nikhil Chelliah} 📖	_OysteinHoiby 💻	_{Patrick Forringer} 🔌	_Paul 📖 📝 🌍	_{Phillip Thelen} 💻
_Pixieish 📖	_{Prof. dr. Sorcha Ní Dhubhghaill} 📖	_{Quentin FELIX} 💻 🎨	_{Rik Hekker} 🐛	_{Sam Livingston-Gray} 📖	_Sanne 💻 📖	_{Sara Latorre} 🌍
_SeaZeeZee 📖 💻	_{SimonbJohnson} 🐛	_Slylele 📖 🌍	_Soazillon 🌍	_SoneaTheBest 🌍	_{Stefan Sydow} 🌍 📖 💻	_Tríona 📖
_Unmutual 📖	_{Wouter van Wageningen} 💻 🎨 🔧	_amysews 📖	_anna-puk 💻	_{beautifulsummermoon} 🌍	_berce 📖	_biou 💻
_{bobgeorgethe3rd} 💻 📖 🎨	_brmlyklr 📖	_chri5b 💻 ⚠️	_dingcycle 🌍	_{drowned-in-books} 💬	_econo202 📖	_ericamattos 🌍
_{fightingrabbit} 💻	_gaylyndie 📖	_grimlokason 💻	_hellgy 🎨	_jackseye 📖	_marckiesel 🌍	_mesil 🐛
_starfetch 💻 📖 🌍 🎨	_ttimearl 🖋	_{tuesgloomsday} 📖	_valadaptive 💻	_viocky 🌍	_woolishboy 💻	_yc 🌍

This project follows the all-contributors specification. Contributions of any kind welcome!

remark-jargon dependencies

unist-util-visit

FAQs

What is remark-jargon?

A Remark plugin for jargon terms. Visit Snyk Advisor to see a full health score report for remark-jargon, including popularity, security, maintenance & community analysis.

Is remark-jargon popular?

The npm package remark-jargon receives a total of 19 weekly downloads. As such, remark-jargon popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is remark-jargon well maintained?

We found indications that remark-jargon is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is remark-jargon safe to use?

The npm package remark-jargon 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 16 November-2024, at 09:31 (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