# @caudex/codex-editor

> Codex editor

Latest version **1.1.0** (published 2020-03-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install @caudex/codex-editor
pnpm add @caudex/codex-editor
yarn add @caudex/codex-editor
bun add @caudex/codex-editor
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2020-03-23 |
| First published | 2020-03-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 21.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | caudex |

## Links

- npm: https://www.npmjs.com/package/@caudex/codex-editor
- Repository: https://github.com/kevinhu/codex-editor
- Issues: https://github.com/kevinhu/codex-editor/issues
- npm.io page: https://npm.io/package/@caudex/codex-editor

## Recent versions

- 1.1.0 (latest) — 2020-03-23
- 1.0.1 — 2020-03-10
- 1.0.0 — 2020-03-10

## README

# Codex text editor

This repository contains the text editor module used in [Codex](https://github.com/alexjwang/codex). The Codex editor is based off of the Toast UI editor, and it is composed of the [React wrapper](https://github.com/nhn/toast-ui.react-editor) and the [tui-editor itself](https://github.com/nhn/tui.editor).

## Installation

To download the editor, run `git submodule update --init --recursive` from the root directory of `/codex`. This will clone the editor submodule into its folder.

Next, build the editor by running `cd editor && npm install && npm run build`.

To install into the client, run `npm install --save ../codex-editor` from `/codex/client`. This installs the editor as a node module so that it can be used by the client.

## Development

Making changes to the editor and seeing these changes in real-time requires a few configuration steps:
1. To link changes to the editor to the one installed in `/codex/client`, run `npm link` in `/codex/codex-editor` and then `npm link @caudex/codex-editor`. Otherwise, `npm install --save ../codex-editor` must be run after each change to the editor.
2. The files for the editor itself are contained inside the editor directory and compiled using [webpack](https://webpack.js.org/) into single files for the editor and viewer that the React wrapper then uses. Compiling from scratch takes about 20 seconds, but changes can be automatically compiled in ~1s by building the editor in watch mode. To do this, run `npm run watch` from the `editor` directory.

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