skaryna

What You See is What You Mean editor inspired by projects like Medium-Editor, Lackey and ProseMirror

Usage no npm install needed!

<script type="module">
  import skaryna from 'https://cdn.skypack.dev/skaryna';
</script>

README

Skaryna

![Skaryna Logo](logo.png?raw=true "" =250x)

NPM, BOWER users. I am only locking package name. Package is not ready for use.

Inspirations

Golas

  • Opinionated and restrictive

    • force structure
    • allow specifing allowed elements per area

  • With extendable model

  • Actual WYSIWYM (not like ProseMirror which break idea of WYSIWYM in approach to marks)

  • Touch and handheld friendly

  • Mordern browsers support only

  • Easilly skinnable and extendable

  • Server side processing

  • No added tags or styles (not like ProseMirror which while editing adds loads)

  • Multiple editors on page support

  • Use only data-* attributes

  • Loads from Text, HTML Markdown, Carbon and ProseMirror formats.

  • Allows usage as just single elements (like h1)

  • Allows attaching own render

  • Lack of dependencies

  • Multiple documents

  • Not allow inline images

  • TextNodes

  • Text - standalone

  • Paragraph

  • Heading

  • Quote

  • BlockNodes

  • Image

  • Video

  • Embed

  • Component

  • Table

  • List

Carbon looks like best example to complete goals, but one, last but not least goal is to increase understanding of contentEditable within our team.

Project will be lead in align with POM definition from Lackey CMS.

Architecture


/-------------\
| Data Source |
\-------------/
       ^
       |
       |
       v
/-------------\             /--------\
| Repository  |-- UPDATE -->| Editor |
\-------------/             \--------/
       ^                         |
       |                         |
       \--------- CHANGE --------/
  • Repository fetch data from data source and update it
  • Editor on init sends static data to repository
  • Editor asks repository for data
  • Repository updates editors
  • Editor inform repository about new nodes
  • Nodes inform repository about content changes

Project Name

Francysk Skaryna (pronounced [franˈt͡sɨsk skaˈrɨna]; or Skoryna; Belarusian: Францыск (Францішак[1]) Скарына; ca. 1490–before 29 January 1552) was a Belarusian humanist, physician, translator and one of the first book printers in Eastern Europe, laying the groundwork for the development of the Belarusian language. More on Wikipedia.

Licence

MIT forever