JSPM

  • Created
  • Published
  • Downloads 76
  • Score
    100M100P100Q72259F
  • License Apache2.0

Angular re-implementation of StackEdit

Package Exports

  • ngx-stackedit
  • ngx-stackedit/package.json

Readme

ngx-stackedit

Build Status NPM version

Full-featured, open-source Markdown editor based on PageDown, the Markdown library used by Stack Overflow and the other Stack Exchange sites. This is an Angular rewrite of the StackEdit implementation.

  • Rewrote editor and preview components to use Angular instead of Vue
  • Rewrote several files to TS
  • Added support for more inline editor rendering
  • Upgraded dependencies
  • Optimized event handling (generically across clEdit)
  • Improved content parsing on paste (duplicate lines, extra spaces etc.)
  • Improved dark & light mode support
  • Packaging for Angular component distribution

https://stackedit.io/

Developing

npm install

npm run dev # Start live-reload dev server on localhost:8080

Building

# production build in ./dist
npm run build

# build for production and view the bundle analyzer report
npm run build:analyze

Roadmap:

  • Clicking on already selected text does nothing
  • Events need reworked
  • CL Editor needs to be rewritten into a TS Class
  • Grammars need to be reviewed

Custom Markdown Syntax

External (visible) syntax

This syntax is visible in the editor panel. It can be edited as raw text.

  • simple styling in span tags
    • Pretty colors

Internal (hidden) syntax

This syntax is abstracted in the editor. It is non-editable and is used for the rich-preview of content in the editor panel

  • Injected rich text (HTML) content
    • ```{{html content}}```
  • Image upload spinner
    • ```image-spinner```