Markdown Browser & Markdown render Function. Markdown ( HTML5 Extended )
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
libs
markdown-docs
LICENSE
README.md
bower.json
browser-with-highlight-example.html
example-browser-with-highlight.html
example-browser.html
example-render.html
index.md
m_markdown.css
m_markdown.js

README.md

markdown-extended

Markdown Browser[nav-top] Markdown render Function. Markdown ( HTML5 Extended )

How to use m_markdown.js ?

Like a simple functionality of markdown string encode.

<script src="m_markdown.js"></script>
<script>console.log( 'Markdown is **sweet**'.markdown() );</script>

Browser Markdown pages like HTML one

To build Browser functionality like this documentation

<link rel="stylesheet" href="m_markdown.css" />
<script type="text/javascript" src="m_markdown.js"></script>
<script type="text/javascript" src="m_urlcapture.js"></script>
<script type="text/javascript" src="m_urlload.js"></script>
<div class="m-markdown-browser-example"></div>
<script type="text/javascript">
	var browser	= m_markdown.setBrowser({
		// force to load an url
		// url		: "http://my-site.com/markdown-docs/index.md",
		base	: "http://my-site.com/markdown-docs/",
		node	: document.querySelector('.m-markdown-browser-example')
	}, function (eventName, methods) {
		if (eventName === "init") {
			window.browser	= methods;
		}
	});
</script>

Supported features

  • Headers #
  • Blockquotes >
  • Ordered lists 1
  • Unordered lists *
  • Paragraphs
  • Links []()
  • Images ![]()
  • Inline <em> emphasis *
  • Inline <strong> emphasis **
  • Escaping of Markdown characters
  • Nesting lists and styles in block, links and paragraph

Unsupported features

  • References and IDs

Additional HTML5 special features

  • Iframes !iframe-100%x200[text in iframe tag](iframe url)
  • HTML5 Videos !video-240x180[title tag for movie](movie.mp4#video/mp4,../3gp/movie.3gp#video/3gp)
  • HTML5 Audios !audio[title tag for audio](audio.mp3#audio/mp3,../ogg/audio.ogg#audio/ogg)
  • Objects !object-100%x200[text in iframe tag](object url)
  • Images !image-100%x200[text in image tag](image url)

Supported browsers

So far m_markdown.js has been tested in recent versions of Opera ( all flavours including Mini ), Chrome, Safari and Firefox. Also it has compatibility with IE from version 10+.

Why ?

It is have functionality to build a browser m_markdown.js is the result of some very structured work. It is easy to use, and it doesnt depend from other libraries.

Examples of usage

In the following code I will describe a set of example, so I will show code examples and then the code functionality

Basic Markdown formatters

Writing a paragraph with a title is so simple... Just typing text, sow below you will see the code example.

## Basic Markdown formatters

Writing an paragraph with a title is so simple... Just typing text, sow below you will see the code example.

Typing different Headers (different sizes)

Each header will be encoded into a HTML header: example # Heading into <h1>Heading</h1>

# Heading 1

## Heading 2

### Heading 3

#### Heading 4

##### Heading 5

###### Heading 6

Typing different text styles

The characters used for text styling are \_, \``, ~and*to escape one of this chars use\so you can type\`to escape``

  • Font weight bold:
    • bold text with __bold text__ or with **bold-text**
  • Font italic:
    • italic text with _italic text_ or with *italic text*
  • Text underline: underline text with ___underline text___
  • Stroke text: Stroke text with ~stroke text~

Adding links

We have multiple types of links

  1. Simple links .. example simple link to index page or CloudWebCode Site [simple link to index page](/) or [CloudWebCode Site](//www.cloudwebcode.com)
  2. Links that we open in new window simple link to open new page[blank] [simple link to open new page](//www.google.com)[blank]
  3. Links for downloading HTML5 download link for m_markdown css file[download=m_markdown.css] [download link for *m_markdown css file*](../m_markdown.css)[download=m_markdown.css]
  4. Links with names and links with local address link with name[link-name-01] and link with local address [link with *name*](/)[link-name-01] and [link with local address](#link-name-01)

Adding Quotes

Text for a blockquote, it can br written on multiple line easily

> Text for a blockquote, it can br written on multiple
> line easily

Goto: Index, Top

Adding inline code sections

  1. Adding simple inline code, example: inline-code with \inline-code``
  2. Adding simple row code, example: example of row code with \`example of row code```
  3. Adding set on rows of code, example:

Adding code section using \```

Currenty we added a code with CSS syntax, but supported syntaxes are: clike - C-like ( CPP, C# ); clojure; coffeescript; css; diff - Git language ( mode : diff ); ecl; erlang; gfm; go; groovy; haskell; haxe; htmlembedded; htmlmixed - html; javascript; jinja2; less; lua; markdown; mysql; ntriples; ocaml; pascal; perl; php; pig; plsql; properties; python; r; rpm; rst; ruby; rust; scheme; shell - shell, bash, sh; sieve; smalltalk; smarty; sparql; stex; tiddlywiki; tiki; vb; vbscript; velocity; verilog; xml; xquery; yaml; text.

```css
	... your code
```

Result

.markdown-code {
	background-color: #FFF;
	color: #333;
}

Adding code section using tabulation

	.markdown-code {
		background-color: #FFF;
		color: #333;
	}```

Result

.markdown-code {
	background-color: #FFF;
	color: #333;
}

Goto: Top

Attaching image to code

Example of image tag

___Underline Code___ Image in code ![image](image url)

Underline Code Image in code image

Example of image with dimensions

!image-230x27[image](image url)

!image-230x27image

Mixed Example

Lorem link with name index[index] ipsum do ist dolor es ist amet. Imba do recoda leu im sabi foar mi det. Seumo go est success. embed text using underscore ipsum do ist dolor es ist amet. simple link Imba bold text usin asterix and embed text using asterix foar mi det. Seumo go est success. cold text using underscore* do ist dolor es ist amet. Imba do recoda

Download: markdown.css[download=markdown.css] Download: markdown.js[download=markdown.js]

code inline var x = 23;leu im sabi foar mi det. Seumo go est success.

Lorem [link with name `index`](/)[index] ipsum do ist dolor es ist amet. ___Imba do recoda___ leu im sabi foar mi det. Seumo go est success.
_embed text using underscore_ ipsum do ist dolor es ist amet. [simple link](page-2.md) Imba **bold text usin asterix** and *embed text using asterix* foar mi det. Seumo go est success.
__cold text using underscore*__ do ist dolor es ist amet. Imba do recoda

_code inline_ `var x = 23;`leu im sabi foar mi det. Seumo go est success.

Goto: Top

Attaching HTML5 Elements to Markdown

HTML Object

!object-200x23[Object Element](//www.w3schools.com/html/bookmark.swf)

Not showed because object needs source from same origin

HTML Iframe

!iframe-100%x450[pasteview example](https://www.cloudwebcode.com/app/pasteview/i/cd-nb80vd-17flei?embed=1&l=ro)

!iframe-100%x450pasteview example

HTML5 Video Element

!video-200x23[Video Element](//www.w3schools.com/html/movie.mp4#video/mp4;http://www.w3schools.com/html/movie.ogg#video/ogg)

!video-320x240Video Element

HTML5 Audio Element

!audio[Audio Element](//www.w3schools.com/html/horse.mp3#audio/mp3;http://www.w3schools.com/html/horse.ogg#audio/ogg)

!audioAudio Element

Attaching image to code

___Underline Code___ Image in code ![image](image url)
!image-50x100[image](image url)

Underline Code Image in code image !image-50x100image

Goto: Top

Code using \x60 `

``var x = 345;``

Result var x = 345;

code using tabulation

.markdown-code {
	background-color: #FFF;
	color: #333;
	font: 13px Helvetica, arial, freesans, clean, sans-serif;
	word-wrap: break-word;
	line-height: 1.7;
	padding: 0 20px 20px 20px;
	-webkit-font-smoothing: antialiased;

	display		: block;
	text-align	: left;
	float		: initial;
	clear		: initial;
}

CSS code using

```css
	... your code
```

Result

.markdown-code {
	background-color: #FFF;
	color: #333;
	font: 13px Helvetica, arial, freesans, clean, sans-serif;
	word-wrap: break-word;
	line-height: 1.7;
	padding: 0 20px 20px 20px;
	-webkit-font-smoothing: antialiased;

	display		: block;
	text-align	: left;
	float		: initial;
	clear		: initial;
}
* {
	display		: block;
	text-align	: left;
	float		: initial;
	clear		: initial;
}

Goto: Top