# @marks-js/marks

> Unleash the Power of a New kind of Markdown

Latest version **1.1.45** (published 2021-05-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install @marks-js/marks
pnpm add @marks-js/marks
yarn add @marks-js/marks
bun add @marks-js/marks
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.45 |
| Published | 2021-05-26 |
| First published | 2020-07-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 316.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 33 |
| Maintainers | fskorzec |
| Keywords | markdown, documentation, markup |

## Links

- npm: https://www.npmjs.com/package/@marks-js/marks
- Repository: https://github.com/NoMoreDeps/marksjs
- Homepage: https://marksjs.com
- Issues: https://github.com/NoMoreDeps/marksjs/issues
- npm.io page: https://npm.io/package/@marks-js/marks

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 1.1.45 (latest) — 2021-05-26
- 1.1.44 — 2021-01-23
- 1.1.43 — 2021-01-23
- 1.1.42 — 2021-01-23
- 1.1.32 — 2021-01-08
- 1.1.30 — 2021-01-07
- 1.1.26 — 2021-01-07
- 1.1.25 — 2020-09-21
- 1.1.24 — 2020-09-17
- 1.1.23 — 2020-09-15
- 1.1.22 — 2020-09-15
- 1.1.12 — 2020-09-15
- 1.1.10 — 2020-09-15
- 1.1.9 — 2020-09-15
- 1.1.6 — 2020-08-28
- … 54 more at https://npm.io/package/@marks-js/marks/versions

## README

Unleash the Power of a New kind of Markdown

<p align="center"><a href="https://github.com/NoMoreDeps/marksjs"><img src="https://marksjs.com/assets/banner.gif" /></a></p>

## { Marks }

**Marks** is a markup language and a renderer that aims to keep the simplicity of *Markdown*,  
and brings a world of possibilities by removing its limits...

Discover it on its official website ***[Marks Website](https://marksjs.com)***.

**Marks** is almost compatible with Markdown, but brings more flexibility using styles, and allows the creation of custom components in an universal and easy way.

![CI](https://github.com/NoMoreDeps/marksjs/workflows/CI/badge.svg)

### Installation
```sh
# With npm
npm i -S @marks-js/marks

# With yarn
yarn add @marks-js/marks
```
**Marks** comes with Typescript declaration files, so you don't need to install separated definition.

### Get started

#### Minimal setup
```typescript
// Import the minimal set of Objects
import { MarksRenderer, Plugins } from "@marks-js/marks";

// Create a new instance of Marks renderer
const marks = new MarksRenderer();

// Register the default plugins in order to make it work
marks.registerRenderers(
  ...Plugins().map(_ => new _()), 
);

const htmlNode = marks.render(` Marks code here `);
document.querySelector("#MoutingPoint").appendChild(htmlNode);

// Alternaticely, you can pass the node as a second parameter
marks.render(` Marks code here `, document.querySelector("#MoutingPoint"));
```

**Marks** is compatible with almost *Markdown* syntax, so what is `cool` in *Markdown*, is still 
available in **Marks**. But Marks allows you to add styles, so it is now possible to have a page written in **Marks** with css.

For full documentation please see it on ***[Marks website](https://marksjs.com)*** or ***[Marks documentation](https://marksjs.com/guide)***

Extra `plugins` and `themes` will be available soon.

To test it in live, go to the ***[Playground](https://marksjs.com/repl)***.

Marks website is *`In Progress`*, so keep an eye on it.

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