# @retronav/ixora

> An extension pack to make interactive markdown editors using CodeMirror 6.

Latest version **0.3.3** (published 2023-04-28) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @retronav/ixora
pnpm add @retronav/ixora
yarn add @retronav/ixora
bun add @retronav/ixora
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.3 |
| Published | 2023-04-28 |
| First published | 2022-06-04 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 12 |
| Unpacked size | 125 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Pranav Karawale |
| Maintainers | retronav |
| Keywords | codemirror, markdown, wysiwyg, editor, wysiwym |

## Links

- npm: https://www.npmjs.com/package/@retronav/ixora
- Repository: https://codeberg.org/retronav/ixora
- Homepage: https://ixora.karawale.in
- Funding: https://liberapay.com/retronav
- npm.io page: https://npm.io/package/@retronav/ixora

## Dependencies (12)

- [dompurify](https://npm.io/package/dompurify.md) ^3.0.1
- [codemirror](https://npm.io/package/codemirror.md) ^6.0.1
- [@lezer/common](https://npm.io/package/@lezer/common.md) ^1.0.2
- [@lezer/markdown](https://npm.io/package/@lezer/markdown.md) ^1.0.2
- [@codemirror/view](https://npm.io/package/@codemirror/view.md) ^6.9.4
- [@lezer/highlight](https://npm.io/package/@lezer/highlight.md) ^1.1.4
- [@codemirror/state](https://npm.io/package/@codemirror/state.md) ^6.2.0
- [@codemirror/commands](https://npm.io/package/@codemirror/commands.md) ^6.2.2
- [@codemirror/language](https://npm.io/package/@codemirror/language.md) ^6.6.0
- [@codemirror/lang-html](https://npm.io/package/@codemirror/lang-html.md) ^6.4.3
- [@codemirror/legacy-modes](https://npm.io/package/@codemirror/legacy-modes.md) ^6.3.2
- [@codemirror/lang-markdown](https://npm.io/package/@codemirror/lang-markdown.md) ^6.1.1

## Alternatives

- [ext-list](https://npm.io/package/ext-list.md) — 6.3M weekly downloads
- [@lexical/selection](https://npm.io/package/@lexical/selection.md) — 3.8M weekly downloads
- [@lexical/text](https://npm.io/package/@lexical/text.md) — 3.6M weekly downloads
- [@lexical/clipboard](https://npm.io/package/@lexical/clipboard.md) — 3.0M weekly downloads
- [@tiptap/extension-mention](https://npm.io/package/@tiptap/extension-mention.md) — 3.0M weekly downloads

## Recent versions

- 0.3.3 (latest) — 2023-04-28
- 0.3.2 — 2022-07-27
- 0.3.1 — 2022-07-27
- 0.3.0 — 2022-07-21
- 0.2.1 — 2022-06-30
- 0.2.0 — 2022-06-30
- 0.1.4 — 2022-06-12
- 0.1.3 — 2022-06-05
- 0.1.2 — 2022-06-04

## README

<p align="center">
    <img
    height="150px"
    src="https://codeberg.org/retronav/ixora/raw/branch/main/assets/logo.svg"
    alt="Ixora logo" />
</p>

# Ixora

[![CI build](https://ci.codeberg.org/api/badges/retronav/ixora/status.svg)](https://ci.codeberg.org/retronav/ixora)
[![npm version](https://img.shields.io/npm/v/@retronav/ixora?logo=npm&style=flat)](https://www.npmjs.com/package/@retronav/ixora)

> WARNING: Ixora is under heavy development, but is quite usable.

Ixora is a CodeMirror 6 extension pack to make writing
Markdown fun and beautiful.

This library includes:

-   Proper heading font sizes
-   Hidden decoration marks (`*italic*` -> `italic` but style is preserved)
-   Auto link detection
-   Support for ID links (eg. `[Foo bar](#foo-bar)`)
-   YAML frontmatter support
-   Styling for lots of Markdown elements
-   [Lots more?](./TODO.md)

## Installation

1. Install the `@retronav/ixora` package using the package manager
   of your choice.
2. Import the extensions you need
    ```ts
    import { headings, codeblock, list } from '@retronav/ixora';
    ```
    Or import all of them at once
    ```ts
    import ixora from '@retronav/ixora';
    ```
3. Add them in the `extensions` parameter of your CodeMirror editor creation
   function.

    ```ts
    const editor = new EditorView({
    	state: EditorState.create({
    		extensions: [
    			// If you import all at once
    			ixora,

    			// ...

    			// If you import indivivually
    			headings(),
    			codeblock(),
    			lists()

    			// ...
    		]
    	})
    });
    ```

Check `test/util.ts` for an example of how to use Ixora with CodeMirror.

# Additional information

## License

The source code is licensed under the
[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt).

The artwork is licensed under
[CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).

## The logo

The logo of this project is derived from
[the Markdown Mark](https://dcurt.is/the-markdown-mark)
by [Dustin Curtis](https://dcurt.is/). The logo uses the color #FF2400
(scarlet). Instead of the arrow pointing downward, there is an
ixora flower beside the "M" which can be thought of as an arrow pointing upward.

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