SynCap / GFMR

Github Flavored Markdown Renderer, Chrome extension

GF Markdown Rendering extension

Copyright ©2013,2015,2016 Constantin Loskutov, www.syncap.ru

@version: 2.1.4

Description

Automatically parse markdown files (.md, .markdown, .text) into HTML. Supports some GFM (Github Flavored Markdown ) features.

Based on markdown-it and highlighter.js.

By default, extension permissions lets you view .md and .markdown files with any URL, including file:// (ie - local files), but not GitHub!

The look of full README rendered with this extension.

Advantages

• Autosubstitute on some combinations, i.e. ( c ) => © etc
• Really render the tables

Weaks

• Because of nature of rendering (Javascript regexps) not recommended to view large .md files and/or files with complex rules
• Some differenses in manner of rendering some blocks, such as tables

Sample

Distinctions of initial specifications

• Supports paragraphs in list items
• Renders Github style code blocks
• Renders tables
• Auto convert the hyper links in plain text, ie: www.example.com, http://example.com
• Converts [ ], [-], [x], [v] and [?] in list items to checkmark list (see TODO section below), where x,X, v, V and ? treated as checked marks, else as unchecked

More info

Legend

ver	What's up?
1.xx	Past realease was based on ShowDown.js
1.4.x..	Based on SD2.js
1.7.x..	Code starts using syntax highlighter highlight.JS
2.0	Render Engine changed to Markdown - it.js, new makeup, fresh look, unique color scheme for code syntax highlighting
2.1	Current release; [+] line numbers in multiline code, [+] striped background for muliline code

TODOs

for v2

• Code line numbers
• Striped background for code (Zebra style)
• Turn On/Off TOC (on fly) Deleted due the on-screen TOC with MD kind files is not neccessary
• Autogenerated interactive TOC (table of contents), based on used heading
• Hot swap for makeup
• Hot swap for code highlighting color schemes

for v3

• Automatic rearrange big images
• [?] Simple tab tables: find blocks of text arranged by columns and convert them to simple tables, as it was with SD2
• RST style tables, with compact multiline cells
• Render scientific formulas (mathematics, chemistry, etc)

License

MIT

Original Attributions

Markdown-It Copyright (c)2014 by:

• Alex Kocharin github/rlidwka
• Vitaly Puzrin github/puzrin

Original Markdown Copyright (c) 2004-2005 John Gruber http://daringfireball.net/projects/markdown/

Redistributable under a BSD-style open source license. See license.txt for more information.