GitXplorerGitXplorer
g

sublime_markdeep

public
7 stars
0 forks
0 issues

Commits

List of commits on branch master.
Unverified
5fc96919ef40d2451c1b5dbe915c77b68a1bac03

Update README.md

ggwenzek committed 7 years ago
Unverified
ed0f0b16ab3f5e40c28b9cd94b5754a7ddef8aa5

add markdeep.sublime-settings

ggwenzek committed 7 years ago
Unverified
883c3b20c4a4d8705ccc88a61ea2aaa6d0c95fe0

Merge pull request #2 from ligoore/master

ggwenzek committed 7 years ago
Unverified
644b9c5c8c204a3c6a38d76cff4cd662b4c90631

Added commenting

committed 7 years ago
Unverified
3eabfa23f11f95e0cb7e55a63d36eb1db13e8d5d

add support for shell

ggwenzek committed 8 years ago
Unverified
2d656c1023cc231efe3900f3dfe1151bcd660510

use triple backquotes instead of quadruple

ggwenzek committed 8 years ago

README

The README file for this repository.

Markdeep

Markdeep is a Markdown-like language to generate web pages. IMHO the main avantages versus Markdown are:

  • Markdeep doesn't need compilation, it can directly been opened in a browser.
  • Markdeep can embed Latex formula (with $ ... $ for inline Latex or $$ ... $$ for blocks).
  • Markdeep have table of contents.

More information are available on the Markdeep site.

Getting started

Once this plugin has been installed in Sublime Text, open a file, change the syntax to Markdeep, type markdeep press TAB. You have inserted a snippet containing a simple Markdeep document. Markdeep supports most of the syntax of Markdown, so it's easy to start using it !

Once your file is saved to the disk, you can use File: Open in browser to see you Markdeep in browser. To refresh your browser as soons as you modified your file, I recommend the Firefox Auto Reload plugin.

Differences with Markdown

Code blocks

Code blocks starts and ends with ```. You can use the `` snippet to create a code block. You can add a language to your code block, allowing both Sublime and Markdeep to provide better syntax coloration for it:

``````````````````````````````````` python
def hello():
    print 'hello world'
```````````````````````````````````

Note to developers

Feature requests and feedback are welcomed. The syntax is forked from the Markdown syntax which as several problems. For one it uses a lot of advanced regexes not supported by Sublime latest engine.

Final remarks

I'm using Markdown to write this, just because Github doesn't allow html Readme (and therefore md.html) !