Jquery Markdown

Posted on  by admin
August 27th, 2016

Markdown is a lightweight markup language for creating formatted text using a plain-text editor. John Gruber and Aaron Swartz created Markdown in 2004 as a markup language that is appealing to human readers in its source code form. Markdown is widely used in blogging, instant messaging, online forums, collaborative software, documentation pages, and readme files.

In this article I will tell you about how to create Markdown Editor with React.js and Web Storage

Purpose of this article is not to teach you React.js from scratch, I’m only just going to show you how to create a specific project using React.js and explain the code

  • Showdown is a Javascript Markdown to HTML converter, based on the original works by John Gruber. Showdown can be used client side (in the browser) or server side (with NodeJs).
  • Bending Markdown for Jekyll & GitHub Pages. Jekyll Markdown GitHub Pages Web Development jQuery HTML.
  • Writing is a simple, lightweight online text editor that supports both Markdown and LaTeX syntax. Implemented in jQuery, JavaScript and CSS.

If you want to know more about React.js and explore this technology, I recommend that you go through the following courses on Codecademy

In this project, we will use the following libraries and technologies: React.js, Babel, jQuery, Bootstap, Web Storage, Marked.js and Highlight.js

1) React.js — JavaScript Library for Building User Interfaces

2) Babel — Babel is a JavaScript compiler. We will use it for Setting up React for ES6

3) Marked.js — A markdown parser and compiler

4) Highlight.js — Syntax highlighting for the Web

5 Min Quickstart

Get started by creating a new folder for your project, and name it anything you like. Then, inside that folder, create additional folders and files to match the following structure

Start by creating a index.html file with the connected necessary libraries

Open the js/index.babel in your favorite code editor (for example Sublime Text 3 or Atom) and create a new component that simply displays Hello World on page

Now, run your website on a web server. If you see Hello World on page, it means that you have done everything correctly

If you do not have installed MAMP or WAMP server, for this project you can use Node.js local-web-server package

Now we can get started

First we need to create a text box and markdown preview box where you can see the result of the work

To do this, replace the render function in your component with

and add the following styles to your css/style.css file

Now when you run, your page will look like this

The next step we define a initial default value that the user will see in a textarea. To do this, add getInitialState function before render

and replace

with

Now, every time you run the page, you’ll see the following text in a textarea

Jquery

But you’ve probably noticed that in the preview block nothing. Let’s fix it. Add rawMarkup function immediately after getInitialState that will parse the contents of the text box and output the result in preview box

and replace

with

In this code snippet, I use the standard recommended settings specified in the project repository Marked.js here https://github.com/chjj/marked#usage

and added support syntax highlighting using highlight.js library

and the following code snippet

takes a this.state.content as input, in this case, the contents of the textarea as a result of the output we get the HTML that you will see in preview box

If you try to change the contents of the textarea notice that your changes are not displayed in the preview box. To fix this, add the following handleChange function after getInitialState

and replace

with

Function handleChange is attached to the textarea onChange event. The handleChange function updates the components state with the new value of textarea. This causes the component to re-render with the new value

So when you change the markdown in the textarea field you will see changes in the preview

At this point, your code in index.babel file should look like this

index.babel

Using Web Storage

Suppose a user has written a large amount of text and reload the page by accident, reset computer or even any of the case for which the user did not have time or are not able to save the typed text. The user will probably be upset

What can we do in this case and how to prevent it?

We will keep all written user’s markdown to Local Storage and after each restart page, restarted browser or rebooting the PC, the user will see the text written by him

To do this, add the componentWillMount function immediately after rawMarkup

Jquery Markdown Google

This code snippet we use to load JavaScript, which is in the file ./js/storage.js on our page within the script tag and execute it every time our component is rendered

Note that the path to storage.js file must be specified relative to the file index.html

Now include the jQuery adding to render

and add the following code in your js/storage.js file

or without jQuery

In this code snippet, we check the user’s browser supports Local Storage (you can check the browser compatibility using the service Can I Use) and if Local Storage is support we add an event listener to the textarea. Every time the input event is fired on them, it means something has changed and we save textarea contents with all changes to Local Storage with markdownStorage key

Finally, replace the initial default value

with add text from Local Storage

Now, if the user has in Local Storage markdownStorage key, to the textarea will be inserted its contents. If markdownStorage key not found or empty then user will see a default value

Jquery Markdown

Full Code

index.html

css/style.css

js/index.babel

js/storage.js

Find By Name provides a less bug-prone way to find elements by their name attribute. In particular, when the name attribute is stored in a variable it is very bug-prone to write a selector for it by hand every time.

Tags

Changelog

17 Jun 2013 version 0.1.1
  • I forgot to quote the name, which was kinda the point
02 Jun 2013 version 0.1.0
  • 0.1.2 title consistency
  • 0.1.1 license is markdown
  • license -> markdown
  • Behold jquery-radio
  • Logos
  • Push version 0.1.0
  • first commit

Similar plugins

Load Later

jQuery plugin for partial loading non essential DOM elements

Shadow UI

Create Shadow DOM based UI components, such as dropdowns, modals, popups, tooltips, blobs, etc.

hoe.js – javascript for peasants

lightweight javascript library designed to streamline the creation of user interface in...

Jquery Markdown Editor

jQuery Scrollfire

Allows useful callbacks to be fired upon elements scrolling into and out of view from both the top...

UpDown.js

UpDown.js provides a flexible way to traverse through containers and their child elements with...

jQuery Breakpoint

Allows useful callbacks to be fired at set 'breakpoints' or window sizes reached upon...

jQuery Even If Hidden

Get information about hidden DOM elements

domajax.com – use Ajax without JavaScript

Domajax is a free jQuery plugin that give you tools to add ajax calls within your application,...

randomizer

jQuery plugin that give you functions to get/set random values or call random functions.

jQuery Eye

jQuery.eye is a jQuery plugin for monitoring changes made to elements' DOM or CSS properties as...

jQuery Selfheal

jQuery plugin for gentle animation of (list) elements being removed or added to the DOM. Inspired...

jQuery Lock Fixed

jQuery plugin which allows for DOM elements to be positioned anywhere on the page, and lock within...

Phery.js PHP Ajax

The bridge from jQuery to PHP, and vice-versa through AJAX. Using event delegation, forms and...

Live Query

Live Query utilizes the power of jQuery selectors by firing callbacks for matched elements...

jQuery Subordinate

.subordinate() is a combination of .append() and .find(). It appends an element but returns this...

jQuery DOMChanged event

jQuery plugin for DOM change observer events

findSafe

Query a selector while ignoring matches within specific nested elements.

Js Markdown To Html

jQueryCreate

The jQuery creator plugin Allows you to create your elements using CSS selectors syntax. Don't use...

jQuery DOM Cache

Using $.cache (or $.domCache) may dramatically increase the performance of your web application by...

qTip2 – Pretty powerful tooltips

Introducing... qTip2. The second generation of the advanced qTip plugin for the ever popular...

Best Jquery Markdown Editor

Please enable JavaScript to view the comments powered by Disqus.