Skip to content

opensly/mist

Repository files navigation

Mist

This repository is an Angular workspace with two parts:

Path Purpose
src/ Marketing website for the Mist Editor library (live demo, docs, getting started)
projects/mist-editor/ The publishable mist-editor npm package

Quick start

npm install
npm start          # marketing site — compiles library from projects/mist-editor/src (no pre-build)
ng build mist-editor   # only needed to publish dist/mist-editor to npm

Dev note: The homepage resolves mist-editor from library source via tsconfig paths, not dist/. You do not need ng build mist-editor to test changes locally. Restart ng serve (stop and run npm start again) after pulling or editing library code so the dev server picks up changes.

Library

Install the editor in your own Angular app:

npm install mist-editor
import { RichTextEditorComponent, EditorToolbarComponent } from 'mist-editor';

See projects/mist-editor/README.md for the full API and integration guide.

Workspace layout

mist/
├── src/                    # Marketing app (demo + docs)
├── projects/mist-editor/   # Angular library source
├── dist/mist-editor/       # Built library (after ng build mist-editor)
├── angular.json
└── package.json            # Workspace root ("mist")

Development

ng serve                    # Run marketing site (resolves mist-editor from projects/mist-editor/src)
ng build mist-editor        # Build library package for publishing
ng test mist-editor         # Run library unit tests

Test

npm test                 # all unit tests (Vitest via ng test)
ng test mist-editor      # library only
ng test mist             # marketing app only
npm run test:watch       # watch mode
npm run test:coverage    # coverage report (see coverage/)

About

A modern & production-ready rich-text editor built with Angular/TypeScript.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors