diff --git a/README.md b/README.md index 45c6eae..4ea7272 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,23 @@ -A Silverstripe module for enabling support for Markdown syntax with server-sided rendering and content editing support. +### A Programmer-Friendly Alternative to the Default TinyMCE Editor ---- +Let’s be honest, the current [TinyMCE editor](https://www.tiny.cloud/) used by [Silverstripe](https://silverstripe.org/) for editing page content falls short in several ways. Its WYSIWYG interface often fails to accurately reflect what will be displayed on the final page, making content editing a frustrating experience. Manipulating HTML elements within the editor is awkward, with tags either mysteriously disappearing or being added unexpectedly. For those who work with technical content, this is more than a minor inconvenience—it’s a nightmare. + +### The Problem + +For technical bloggers and developers, managing embedded media (videos, images, code snippets) in TinyMCE is a constant challenge. The editor's lack of reliable control over HTML makes the content less portable and error-prone, forcing users to repeatedly fine-tune the formatting to get things right. The result? Wasted time and headaches, especially when consistency across pages is a priority. -## Goal +### The Solution -Let's be honest, the existing [TinyMCE editor](https://www.tiny.cloud/) used by [Silverstripe](https://silverstripe.org/) for editing page content absolutely sucks. It's WYSIWYG editor produces an inaccurate rendering of what will be displayed on the final page, and editing HTML elements in the editor pane is awkward and prone to mistakes. HTML elements either mysteriously disappear or get unexpectedly added. +This Silverstripe module aims to replace the current WYSIWYG approach with a more programmer-friendly editor that uses **Markdown**. Markdown is widely appreciated for its simplicity and versatility, making it a natural choice for developers who want more control over the final output. -For technical blogging, this can be an complete nightmare especially when embedding other forms of media such as video, images, and code snippets. It also makes the content a lot less portable. This Silverstripe module proposes using something that is friendlier for programmers instead, and letting the server render the HTML from the source Markdown "code" as desired. +### Key Features -- Integrate an editor into Silverstripe that is friendly with Markdown syntax. -- Add extensible server-sided support for rendering Markdown into HTML with Bootstrap 5 styling. +- **Markdown-Friendly Editor:** The module integrates a Markdown editor into Silverstripe, offering a much more streamlined and familiar experience for programmers and technical writers. +- **Server-Side Rendering with Bootstrap 5 Support:** The Markdown input is rendered server-side into clean HTML, styled using **Bootstrap 5**. This ensures consistent and responsive presentation, without sacrificing the control and precision developers expect. +- **Extensible and Customizable:** The module is designed to be extensible, allowing developers to tweak and expand upon the Markdown-to-HTML rendering process as needed. ---