2021-02-06 10:19:57 +01:00
2019-10-12 12:24:37 +02:00
< p align = 'center' > < a
2019-10-12 13:41:37 +02:00
href="https://www.npmjs.com/package/remark-jargon"
title="remark-jargon on NPM"
>< img src = "https://img.shields.io/npm/v/remark-jargon.svg"
alt="remark-jargon on NPM"/>
2019-10-12 12:24:37 +02:00
< / a > < a
href="https://opensource.org/licenses/MIT"
title="License: MIT"
2019-10-12 13:41:37 +02:00
>< img src = "https://img.shields.io/npm/l/remark-jargon.svg?label=License"
2019-10-12 12:24:37 +02:00
alt="License: MIT"/>
< / a > < a
href="https://deepscan.io/dashboard#view =project& tid=2114& pid=2993& bid=23256"
title="Code quality on DeepScan"
>< img src = "https://deepscan.io/api/teams/2114/projects/2993/branches/23256/badge/grade.svg"
alt="Code quality on DeepScan"/>
< / a > < a
href="https://github.com/freesewing/freesewing/issues?q=is%3Aissue+is%3Aopen+label%3Apkg%3Aremark-jargon"
title="Open issues tagged pkg:remark-jargon"
>< img src = "https://img.shields.io/github/issues/freesewing/freesewing/pkg:remark-jargon.svg?label=Issues"
alt="Open issues tagged pkg:remark-jargon"/>
2021-02-06 10:19:57 +01:00
< / a > < a
href="https://todo.freesewing.org/"
2021-02-06 12:28:02 +01:00
title="Project board"
>< img src = "https://img.shields.io/badge/%F3%A0%80%A0-Project%20board-9775fa.svg?logo=github&logoColor=white&logoWidth=15"
alt="Project board"/>
2019-10-12 12:24:37 +02:00
< / a > < / p > < p align = 'center' > < a
href="https://twitter.com/freesewing_org"
title="Follow @freesewing_org on Twitter"
>< img src = "https://img.shields.io/badge/%F3%A0%80%A0-Follow%20us-blue.svg?logo=twitter&logoColor=white&logoWidth=15"
alt="Follow @freesewing_org on Twitter"/>
< / a > < a
2020-10-03 16:01:37 +02:00
href="https://chat.freesewing.org"
title="Chat with us on Discord"
>< img src = "https://img.shields.io/discord/698854858052075530?label=Chat%20on%20Discord"
alt="Chat with us on Discord"/>
2019-10-12 12:24:37 +02:00
< / a > < a
href="https://freesewing.org/patrons/join"
title="Become a FreeSewing Patron"
>< img src = "https://img.shields.io/badge/%F3%A0%80%A0-Support%20us-blueviolet.svg?logo=cash-app&logoColor=white&logoWidth=15"
alt="Become a FreeSewing Patron"/>
< / a > < a
href="https://instagram.com/freesewing_org"
title="Follow @freesewing_org on Twitter"
>< img src = "https://img.shields.io/badge/%F3%A0%80%A0-Follow%20us-E4405F.svg?logo=instagram&logoColor=white&logoWidth=15"
alt="Follow @freesewing_org on Twitter"/>
2021-11-27 20:06:56 +01:00
< / a > < a
href="#contributors -"
title="All Contributors"
>< img src = "https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square"
alt="All Contributors"/>
2019-10-12 12:24:37 +02:00
< / a > < / p >
2021-02-06 10:25:28 +01:00
# remark-jargon
2019-10-12 12:24:37 +02:00
A Remark plugin for jargon terms
2019-10-12 16:12:33 +02:00
## About
This [Remark ](https://remark.js.org/ ) plugin allows you to use _jargon_ in your
markdown/mdx content and use a centrally managed file of jargon terms and their definitions.
2019-10-12 18:02:13 +02:00
## 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:
```js
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:
```js
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:
```css
// 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 ](https://github.com/freesewing ).
For help or feedback, please stop by [the FreeSewing chat room ](https://gitter.im/freesewing/development ) or
[create an issue ](https://github.com/freesewing/freesewing/issues/new ).
## Use with Gatsby
2019-10-12 16:12:33 +02:00
Please see [gatsby-remark-jargon ](https://github.com/freesewing/freesewing/tree/develop/packages/gatsby-remark-jargon ) for
2019-10-12 18:02:13 +02:00
info and instructions on how to use this plugin with [Gatsby ](https://www.gatsbyjs.org/ ).
2019-10-12 12:24:37 +02:00
2021-02-06 10:25:28 +01:00
## What am I looking at? 🤔
This repository is our *monorepo*
holding [all our NPM packages ](https://freesewing.dev/reference/packages/ ).
This folder holds: remark-jargon
2019-10-24 18:52:12 +02:00
## About FreeSewing 💀
2019-10-12 12:24:37 +02:00
Where the world of makers and developers collide, that's where you'll find FreeSewing.
2021-02-06 10:19:57 +01:00
If you're a maker, checkout [freesewing.org ](https://freesewing.org/ ) where you can generate
our sewing patterns adapted to your measurements.
If you're a developer, our documentation is on [freesewing.dev ](https://freesewing.dev/ ).
2020-03-16 09:29:25 +01:00
Our [core library ](https://freesewing.dev/reference/api/ ) is a *batteries-included* toolbox
2021-02-06 10:19:57 +01:00
for parametric design of sewing patterns. But we also provide a range
of [plugins ](https://freesewing.dev/reference/plugins/ ) that further extend the
functionality of the platform.
If you have NodeJS installed, you can try it right now by running:
2019-10-12 12:24:37 +02:00
```bash
2021-02-06 10:19:57 +01:00
npx create-freesewing-pattern
2019-10-12 12:24:37 +02:00
```
2021-02-06 10:19:57 +01:00
Or, consult our getting started guides
for [Linux ](https://freesewing.dev/tutorials/getting-started-linux/ ),
[MacOS ](https://freesewing.dev/tutorials/getting-started-mac/ ),
or [Windows ](https://freesewing.dev/tutorials/getting-started-windows/ ).
2019-10-12 12:24:37 +02:00
2021-02-06 10:19:57 +01:00
We also have a [pattern design tutorial ](https://freesewing.dev/tutorials/pattern-design/ ) that
walks you through your first parametric design,
and [a friendly community ](https://freesewing.org/community/where/ ) with
people who can help you when you get stuck.
2019-10-12 12:24:37 +02:00
## Support FreeSewing: Become a patron 🥰
FreeSewing is an open source project run by a community,
and financially supported by our patrons.
2021-02-06 10:19:57 +01:00
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 ](https://freesewing.org/community/join ).
2019-10-12 12:24:37 +02:00
## Links 👩💻
- 💻 Makers website: [freesewing.org ](https://freesewing.org )
2019-10-24 18:52:12 +02:00
- 💻 Developers website: [freesewing.dev ](https://freesewing.dev )
2021-06-20 15:56:50 +02:00
- 💬 Chat: On Discord via [discord.freesewing.org ](https://discord.freesewing.org/ )
2021-02-06 10:19:57 +01:00
- ✅ Todo list/Kanban board: On Github via [todo.freesewing.org ](https://todo.freesewing.org/ )
2019-10-12 12:24:37 +02:00
- 🐦 Twitter: [@freesewing_org ](https://twitter.com/freesewing_org )
- 📷 Instagram: [@freesewing_org ](https://instagram.com/freesewing_org )
## License: MIT 🤓
© [Joost De Cock ](https://github.com/joostdecock ).
See [the license file ](https://github.com/freesewing/freesewing/blob/develop/LICENSE ) for details.
## Where to get help 🤯
2020-10-03 16:01:37 +02:00
Our [chatrooms on Discord ](https://chat.freesewing.org/ ) are the best place to ask questions,
2019-10-12 12:24:37 +02:00
share your feedback, or just hang out.
If you want to report a problem, please [create an issue ](https://github.com/freesewing/freesewing/issues/new ).
2021-11-27 20:06:56 +01:00
## Contributors ✨
Thanks goes to these wonderful people ([emoji key ](https://allcontributors.org/docs/en/emoji-key )):
<!-- ALL - CONTRIBUTORS - LIST:START - Do not remove or modify this section -->
<!-- prettier - ignore - start -->
<!-- markdownlint - disable -->
< table >
< tr >
< td align = "center" >< a href = "https://joost.at/" >< img src = "https://avatars.githubusercontent.com/u/1708494?v=4?s=100" width = "100px;" alt = "" />< br />< sub >< b > Joost De Cock</ b ></ sub ></ a >< br />< a href = " #maintenance -joostdecock" title = "Maintenance" > 🚧</ a ></ td >
2021-11-28 17:11:46 +01:00
< td align = "center" >< a href = "https://github.com/starfetch" >< img src = "https://avatars.githubusercontent.com/u/80041179?v=4?s=100" width = "100px;" alt = "" />< br />< sub >< b > starfetch</ b ></ sub ></ a >< br />< a href = "https://github.com/freesewing/freesewing/commits?author=starfetch" title = "Code" > 💻</ a > < a href = "https://github.com/freesewing/freesewing/commits?author=starfetch" title = "Documentation" > 📖</ a > < a href = " #translation -starfetch" title = "Translation" > 🌍</ a > < a href = " #design -starfetch" title = "Design" > 🎨</ a ></ td >
< td align = "center" >< a href = "https://github.com/lucibytes" >< img src = "https://avatars.githubusercontent.com/u/77203781?v=4?s=100" width = "100px;" alt = "" />< br />< sub >< b > Lucian</ b ></ sub ></ a >< br />< a href = " #eventOrganizing -lucibytes" title = "Event Organizing" > 📋</ a ></ td >
< td align = "center" >< a href = "https://github.com/tangerineshark" >< img src = "https://avatars.githubusercontent.com/u/70777269?v=4?s=100" width = "100px;" alt = "" />< br />< sub >< b > Karen</ b ></ sub ></ a >< br />< a href = "https://github.com/freesewing/freesewing/commits?author=tangerineshark" title = "Documentation" > 📖</ a > < a href = " #eventOrganizing -tangerineshark" title = "Event Organizing" > 📋</ a ></ td >
< td align = "center" >< a href = "https://github.com/woutervdub" >< img src = "https://avatars.githubusercontent.com/u/24414629?v=4?s=100" width = "100px;" alt = "" />< br />< sub >< b > Wouter van Wageningen</ b ></ sub ></ a >< br />< a href = "https://github.com/freesewing/freesewing/commits?author=woutervdub" title = "Code" > 💻</ a > < a href = " #design -woutervdub" title = "Design" > 🎨</ a > < a href = " #tool -woutervdub" title = "Tools" > 🔧</ a ></ td >
< td align = "center" >< a href = "https://github.com/bobgeorgethe3rd" >< img src = "https://avatars.githubusercontent.com/u/16866285?v=4?s=100" width = "100px;" alt = "" />< br />< sub >< b > bobgeorgethe3rd</ b ></ sub ></ a >< br />< a href = "https://github.com/freesewing/freesewing/commits?author=bobgeorgethe3rd" title = "Code" > 💻</ a > < a href = "https://github.com/freesewing/freesewing/commits?author=bobgeorgethe3rd" title = "Documentation" > 📖</ a > < a href = " #design -bobgeorgethe3rd" title = "Design" > 🎨</ a ></ td >
< td align = "center" > < a href = "https://github.com/sannek" > < img src = "https://avatars.githubusercontent.com/u/17491062?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Sanne< / b > < / sub > < / a > < br / > < a href = "https://github.com/freesewing/freesewing/commits?author=sannek" title = "Code" > 💻< / a > < a href = "https://github.com/freesewing/freesewing/commits?author=sannek" title = "Documentation" > 📖< / a > < / td >
2021-11-28 17:03:16 +01:00
< / tr >
< tr >
2021-11-28 17:11:46 +01:00
< td align = "center" >< a href = "https://weblog.redisdead.net" >< img src = "https://avatars.githubusercontent.com/u/6494414?v=4?s=100" width = "100px;" alt = "" />< br />< sub >< b > hellgy</ b ></ sub ></ a >< br />< a href = " #design -hellgy" title = "Design" > 🎨</ a ></ td >
< td align = "center" > < a href = "https://github.com/biou" > < img src = "https://avatars.githubusercontent.com/u/1340376?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > biou< / b > < / sub > < / a > < br / > < a href = "https://github.com/freesewing/freesewing/commits?author=biou" title = "Code" > 💻< / a > < / td >
< td align = "center" > < a href = "http://www.chrisbarrett.fr" > < img src = "https://avatars.githubusercontent.com/u/2373249?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > chri5b< / b > < / sub > < / a > < br / > < a href = "https://github.com/freesewing/freesewing/commits?author=chri5b" title = "Code" > 💻< / a > < a href = "https://github.com/freesewing/freesewing/commits?author=chri5b" title = "Tests" > ⚠️< / a > < / td >
< td align = "center" > < a href = "http://thelettereph.com" > < img src = "https://avatars.githubusercontent.com/u/357684?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Andrew James< / b > < / sub > < / a > < br / > < a href = "https://github.com/freesewing/freesewing/commits?author=ephphatha" title = "Documentation" > 📖< / a > < / td >
< td align = "center" >< a href = "https://github.com/AlfaLyr" >< img src = "https://avatars.githubusercontent.com/u/39273729?v=4?s=100" width = "100px;" alt = "" />< br />< sub >< b > AlfaLyr</ b ></ sub ></ a >< br />< a href = "https://github.com/freesewing/freesewing/commits?author=AlfaLyr" title = "Code" > 💻</ a > < a href = " #plugin -AlfaLyr" title = "Plugin/utility libraries" > 🔌</ a > < a href = " #design -AlfaLyr" title = "Design" > 🎨</ a ></ td >
< td align = "center" >< a href = "https://pat.forringer.com/" >< img src = "https://avatars.githubusercontent.com/u/136456?v=4?s=100" width = "100px;" alt = "" />< br />< sub >< b > Patrick Forringer</ b ></ sub ></ a >< br />< a href = " #plugin -destos" title = "Plugin/utility libraries" > 🔌</ a ></ td >
< td align = "center" >< a href = "https://github.com/nataliasayang" >< img src = "https://avatars.githubusercontent.com/u/48160791?v=4?s=100" width = "100px;" alt = "" />< br />< sub >< b > Natalia</ b ></ sub ></ a >< br />< a href = "https://github.com/freesewing/freesewing/commits?author=nataliasayang" title = "Code" > 💻</ a > < a href = " #design -nataliasayang" title = "Design" > 🎨</ a > < a href = " #blog -nataliasayang" title = "Blogposts" > 📝</ a ></ td >
2021-11-28 17:03:16 +01:00
< / tr >
< tr >
2021-11-28 17:11:46 +01:00
< td align = "center" > < a href = "http://www.kieranklaassen.com/" > < img src = "https://avatars.githubusercontent.com/u/209089?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Kieran Klaassen< / b > < / sub > < / a > < br / > < a href = "https://github.com/freesewing/freesewing/commits?author=kieranklaassen" title = "Code" > 💻< / a > < / td >
< td align = "center" > < a href = "https://github.com/jejacks0n" > < img src = "https://avatars.githubusercontent.com/u/13765?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Jeremy Jackson< / b > < / sub > < / a > < br / > < a href = "https://github.com/freesewing/freesewing/commits?author=jejacks0n" title = "Code" > 💻< / a > < / td >
< td align = "center" > < a href = "https://github.com/DocSpencer77" > < img src = "https://avatars.githubusercontent.com/u/43393580?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > gaylyndie< / b > < / sub > < / a > < br / > < a href = "https://github.com/freesewing/freesewing/commits?author=DocSpencer77" title = "Documentation" > 📖< / a > < / td >
< td align = "center" > < a href = "http://polymerisation-des-concepts.fr/" > < img src = "https://avatars.githubusercontent.com/u/365999?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Alexandre Ignjatovic< / b > < / sub > < / a > < br / > < a href = "https://github.com/freesewing/freesewing/commits?author=bankair" title = "Code" > 💻< / a > < / td >
< td align = "center" >< a href = "https://www.darigovresearch.com/" >< img src = "https://avatars.githubusercontent.com/u/30328618?v=4?s=100" width = "100px;" alt = "" />< br />< sub >< b > Darigov Research</ b ></ sub ></ a >< br />< a href = "https://github.com/freesewing/freesewing/commits?author=darigovresearch" title = "Documentation" > 📖</ a > < a href = " #ideas -darigovresearch" title = "Ideas, Planning, & Feedback" > 🤔</ a ></ td >
< td align = "center" > < a href = "https://www.uza.be/persoon/prof-dr-sorcha-ni-dhubhghaill" > < img src = "https://avatars.githubusercontent.com/u/30624634?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Prof. dr. Sorcha Ní Dhubhghaill< / b > < / sub > < / a > < br / > < a href = "https://github.com/freesewing/freesewing/commits?author=sorchanidhubhghaill" title = "Documentation" > 📖< / a > < / td >
< td align = "center" > < a href = "https://www.forresto.com/" > < img src = "https://avatars.githubusercontent.com/u/395307?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Forrest O.< / b > < / sub > < / a > < br / > < a href = "https://github.com/freesewing/freesewing/commits?author=forresto" title = "Documentation" > 📖< / a > < / td >
2021-11-28 17:03:16 +01:00
< / tr >
< tr >
2021-11-28 17:11:46 +01:00
< td align = "center" > < a href = "https://github.com/TriploidTree" > < img src = "https://avatars.githubusercontent.com/u/4170521?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Tríona< / b > < / sub > < / a > < br / > < a href = "https://github.com/freesewing/freesewing/commits?author=TriploidTree" title = "Documentation" > 📖< / a > < / td >
< td align = "center" > < a href = "https://github.com/woolishboy" > < img src = "https://avatars.githubusercontent.com/u/57816321?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > woolishboy< / b > < / sub > < / a > < br / > < a href = "https://github.com/freesewing/freesewing/commits?author=woolishboy" title = "Code" > 💻< / a > < / td >
< td align = "center" >< a href = "https://github.com/ttimearl" >< img src = "https://avatars.githubusercontent.com/u/77916590?v=4?s=100" width = "100px;" alt = "" />< br />< sub >< b > ttimearl</ b ></ sub ></ a >< br />< a href = " #content -ttimearl" title = "Content" > 🖋</ a ></ td >
< td align = "center" > < a href = "https://github.com/grimlokason" > < img src = "https://avatars.githubusercontent.com/u/5112238?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > grimlokason< / b > < / sub > < / a > < br / > < a href = "https://github.com/freesewing/freesewing/commits?author=grimlokason" title = "Code" > 💻< / a > < / td >
2021-11-27 20:06:56 +01:00
< / tr >
< / table >
<!-- markdownlint - restore -->
<!-- prettier - ignore - end -->
<!-- ALL - CONTRIBUTORS - LIST:END -->
<!-- ALL - CONTRIBUTORS - LIST:START - Do not remove or modify this section -->
<!-- prettier - ignore - start -->
<!-- markdownlint - disable -->
<!-- markdownlint - restore -->
<!-- prettier - ignore - end -->
<!-- ALL - CONTRIBUTORS - LIST:END -->
This project follows the [all-contributors ](https://github.com/all-contributors/all-contributors ) specification. Contributions of any kind welcome!
