ngx-md-cake - Markdown Editor

A drop-in textarea replacement for writing beautiful and understandable Markdown. The WYSIWYG-esque editor allows users who may be less experienced with Markdown to use familiar toolbar buttons and shortcuts. In addition, the syntax is rendered while editing to clearly show the expected result. Headings are larger, emphasized words are italicized, links are underlined, etc.

Why not a WYSIWYG editor or pure Markdown?

WYSIWYG editors that produce HTML are often complex and buggy. Markdown solves this problem in many ways, plus Markdown can be rendered natively on more platforms than HTML. However, Markdown is not a syntax that an average user will be familiar with, nor is it visually clear while editing. In other words, for an unfamiliar user, the syntax they write will make little sense until they click the preview button. This editor aims to bridge this gap for non-technical users who are less familiar with or just learning Markdown syntax.

Install

Via npm.

npm install ngx-md-cake --save

Quick start

After installing, add MarkdownCakeModule to your application module:

import {MarkdownEditorModule} from markdown-cake;

@NgModule({
    imports: [MarkdownEditorModule],
})
export class AppModule { 
    //... 
}

And add Font-Awesome 5 to your angular.json:

{
  "projects": {
    "<your-app>": {
      "architect": {
        "build": {
            "styles": [
              "node_modules/@fortawesome/fontawesome-free/css/all.min.css"
            ]
          }
        }
      }
    }
}

This library was generated with Angular CLI version 7.2.0.

Code scaffolding

Run ng generate component component-name --project ngx-md-cake to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module --project ngx-md-cake.

Note: Don't forget to add --project ngx-md-cake or else it will be added to the default project in your angular.json file.

Build

Run ng build ngx-md-cake to build the project. The build artifacts will be stored in the dist/ directory.

Publishing

After building your library with ng build ngx-md-cake, go to the dist folder cd dist/ngx-md-cake and run npm publish.

Running unit tests

Run ng test ngx-md-cake to execute the unit tests via Karma.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.