Package Exports
- @newtil/editor
- @newtil/editor/react
- @newtil/editor/themes/newtil
- @newtil/editor/vue
Readme
🚧 개발 중: 이 패키지는 아직 초기 개발 단계입니다 (v0.1.0). API는 변경될 수 있습니다.
개요
@newtil/editor는 React/Vue/Angular/Vanilla JS 등 어떤 프레임워크에서도 동일하게 쓸 수 있는 Web Component 기반 Markdown 편집기입니다. ProseMirror를 내부 엔진으로 사용하여 Markdown과 HTML을 양방향으로 변환합니다.
특징
- 🧩 프레임워크 중립 — Web Component(Custom Element)로 구현되어 어디서든 동작
- 🔄 Markdown ↔ HTML 양방향 변환 — ProseMirror 기반 안정적인 직렬화
- 📱 모바일/Ionic 지원 — Capacitor 환경 호환
- 🎨
@newtil/css와의 선택적 테마 통합 - 📦 ESM / CJS 지원 — 모던 번들러와 Node 환경 모두 호환
설치
npm install @newtil/editor사용 예시
Vanilla / Ionic / 어디서든
import "@newtil/editor";
// 스타일은 자동으로 주입됩니다<newtil-editor value="# Hello"></newtil-editor>개발
npm install
npm run dev # Vite 개발 서버 실행 (데모 페이지)
npm run build # 라이브러리 빌드 (dist/)
npm run typecheck # 타입 검증문서
프로젝트 설계와 구현 진행 상황은 docs/ 폴더에 정리되어 있습니다.
- docs/README.md — 문서 인덱스
- docs/roadmap.md — 구현 로드맵 (Step 1~7) 과 현재 진행 상태
- docs/design.md — 전체 설계 문서
라이선스
MIT © Newlecture