Define expected WYSIWYG editor behavior for the static site editor
To enable users to easily edit the content of static sites we need to implement a WYSIWYG editor that can give them a sense of content hierarchy and layout while editing, instead of looking at raw Markdown syntax.
When choosing the ideal editor to use the following aspects should be considered:
Technical
- Maturity - how mature is the editor in terms of feature completion and duration existence
- Community - how active is community in reporting and addressing issues and submitting merge/pull requests to the project
- License - it should have an appropriate open source license for us to be able to embed it in our product
- Browser support - it should work in all modern browsers
- Mobile support - does it work on mobile browsers
- Skinning - can we modify the look and feel easily to adapt to our needs
- Extensibility - can we extend it with custom functionality to handle non-standard markdown
- Technology - is it compatible with our current tech stack and not introduce unnecessary dependencies
Behavioral
- Ability to switch between WYSIWYG mode and editing the raw Markdown
- Ability to hide the markdown syntax after applying the formatting.
- Example, typing
## Header 2would remove the##from the string and apply H2 styling.
- Example, typing
- Visual styling and management of tables is a very nice-to-have feature
- Ideally, it would also support copy/paste of tables from Excel or Sheets
Edited by Eric Schurter