Code Monkey home page Code Monkey logo

sublime_markdeep's Introduction

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) !

sublime_markdeep's People

Contributors

gwenzek avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

sublime_markdeep's Issues

Comment for bash in code block

The comment (# CommentText ) in a code block should not formatted like other section text, it is not a section.

Example:
image

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.