# @system76/markdown

> System76 markdown parsing for the web

Latest version **1.0.1** (published 2022-03-10) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install @system76/markdown
pnpm add @system76/markdown
yarn add @system76/markdown
bun add @system76/markdown
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2022-03-10 |
| First published | 2020-02-10 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=8 |
| Dependencies | 3 |
| Unpacked size | 49.5 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 8 |
| Author | System76 |
| Maintainers | system76 |
| Keywords | parser, markdown, frontend, system76 |

## Links

- npm: https://www.npmjs.com/package/@system76/markdown
- Repository: https://github.com/system76/markdown
- Homepage: https://system76.github.io/markdown/
- Issues: https://github.com/system76/markdown/issues
- npm.io page: https://npm.io/package/@system76/markdown

## Dependencies (3)

- [markdown-it](https://npm.io/package/markdown-it.md) ^12.3.2
- [markdown-it-kbd](https://npm.io/package/markdown-it-kbd.md) ^2.0.0
- [markdown-it-link-attributes](https://npm.io/package/markdown-it-link-attributes.md) ^3.0.0

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2022-03-10
- 1.0.0 — 2020-02-10

## README

<div align="center">
  <h1>@system76/markdown</h1>
  <h3>System76 markdown parsing for the web</h3>
  <br>
  <br>
</div>

<p align="center">
  <a href="https://www.npmjs.com/package/@system76/markdown/">
    <img src="https://img.shields.io/npm/v/@system76/markdown.svg" alt="npm">
  </a>

  <a href="https://github.com/system76/markdown/actions?query=workflow%3ACI">
    <img src="https://github.com/system76/markdown/workflows/CI/badge.svg?branch=master" alt="GitHub actions">
  </a>

  <a href="https://renovatebot.com/">
    <img src="https://img.shields.io/badge/renovate-enabled-brightgreen.svg" alt="renovate">
  </a>

  <a href="https://standardjs.com">
    <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="standard">
  </a>

  <a href="https://markdown.origin76.com/">
    <img src="https://cdn.jsdelivr.net/gh/storybooks/brand@master/badge/badge-storybook.svg" alt="Storybook">
  </a>
</p>

---

This repository contains the markdown parser and plugin configuration we use for
System76 websites.

## Using

```
npm install --save @system76/markdown
```

```vue
<template>
  <article v-markdown.full>
    ## This will be parsed as markdown

    so type away!
  </article>
</template>

<script>
import { directive as markdownDirective } from '@system76/markdown'

export default {
  directives: {
    markdown: markdownDirective
  }
}
</script>
```

View [the docs](https://markdown.origin76.com) to see more examples.

## Development

1) Download the repository

2) Run `npm ci`

3) Run `npm start`

4) Start hacking

5) Run `npm test`

6) Make a commit in [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines)
format.

## Deployment

To [trigger a release](https://semantic-release.gitbook.io/semantic-release/#triggering-a-release),
push a commit to the `master` branch in the
[Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines)
format.

---
_Source: https://npm.io/package/@system76/markdown · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._