Github Collapsible Markdown

Posted on  by admin

Collapsible markdown. GitHub Gist: instantly share code, notes, and snippets. How to add a collapsed block with any data. Nov 29, 2016 The GitHub Collapse Markdown is a script for collapsing headers. Will be really nice when I implement persistence for the state of each header. Until then it is more of a gimmick than a useful feature. The Details tag opener is a script which ensures that all detail tags are open after preview is refreshed. We're releasing a formal specification of the syntax for GitHub Flavored Markdown, and its corresponding reference implementation.

In this tutorial we will look at how to create a github style markdown editor with preview button. Github’s markdown editor is used to edit the file. This file contains getting started information about the github repository.

Using EpicEditor

EpicEditor is a JavaScript Library which can embed a mardown editor in an webpage. In this tutorial we will build a Github style markdown tool using EpicEditor.

Download EpicEditor and place it in your demo project. This is how my demo project looks


Create a Sample Editor


Here is the code for a sample markdown editor like Github style. With just 62 lines of code we created a editor like github’s.

<!doctype html>
<title>Github Style Markdown Editing Preview</title>
<divid='epiceditor'style='width: 600px; height: 600px; border: 2px solid black'></div>
<buttononclick='commit();'>Commit Change to Server</button>
var opts = {
container: 'epiceditor',
theme: {
base: '/themes/base/epiceditor.css',
editor: '/themes/editor/epic-light.css'
clientSideStorage: true,
file: {
name: '', //name of local file to open. Its not a real file but just localStorage item.
autoSave: 100 //saves the editor data into the local file every 100ms.
button: {
preview: false,
fullscreen: false,
bar: false
var editor = new EpicEditor(opts);
editor.importFile('','#Last Commited Content'); //load file data from server for the last commit.
function commit()
var theContent_html = editor.exportFile('', 'html');
var theContent_md = editor.exportFile('', 'text');
//here send data to server to update the file on server side.
function preview()
function edit()

Most of the code above is self explanatory.

A editor represents one file at a time. A file name (here it is is assigned to the editor. The markdown is stored/updated locally every 100ms. When user clicks the commit button you can retrieve the markdown of the file and send to server.

Github Collapsible Markdown Download

Whenever page is loaded you can retrieve the markdown of the file from server and load it into the local file using importFile function. Now the editor will show the server version of the file.