Extended Markdown Bundle

[Wardrop]

Would it be possible add support for a few extended markdown features? I'm mainly thinking of support for the commonly used fenced code blocks. If you're concerned about automatically formatting non-standard markdown, then perhaps this could be something that's turned off by default, which can be enabled within the bundle settings.

I understand someone made a request for full github flavoured markdown support #9. If indeed you'd prefer to split this out into a new bundle using markdown as it's base, can I make a vote for that? I think many of these extensions, at least fenced code blocks, are common enough to warrant making it an official bundle.

Perhaps there's an opportunity here to even support the class hinting that fenced code blocks allow, and which is commonly used for code highlighting. So if someone marks a fenced code block with the ruby class hint, then Markdown can render the content of that code block using the grammer from the ruby bundle. That'd be pretty awesome.

Thoughts?

[sorbits]

When I check Babelmark it looks like only PHP Markdown Extra supports
fenced code blocks:
http://babelmark.bobtfish.net/?markdown=Hello%0D%0A%0D%0A~~~%0D%0Aworld%0D%0A~~~%0D%0A&src=1&dest=2

Personally I use TextMate’s syntax highlight as a “validator”,
ensuring that what I write will work regardless of where it is published
(some goes to GitHub, some goes to WordPress, some is converted
locally). It seems there is very little consensus when you go beyond the
Daring Fireball syntax, even though few still use that converter.

As for fenced code blocks though, this should be doable as an injection
grammar, and I’d be open for including that in the default Markdown
bundle (as we can ship it disabld, if we feel it’s misleading to parse
it by default).

On 25 Mar 2013, at 13:50, Tom Wardrop wrote:

Would it be possible add support for a few extended markdown features?
I'm mainly thinking of support for the commonly used fenced code
blocks. If you're concerned about automatically formatting
non-standard markdown, then perhaps this could be something that's
turned off by default, which can be enabled within the bundle
settings.

I understand someone made a request for full github flavoured markdown
support #9. If indeed you'd prefer to split this out into a new bundle
using markdown as it's base, can I make a vote for that? I think many
of these extensions, at least fenced code blocks, are common enough to
warrant making it an official bundle.

Thoughts?

---

Reply to this email directly or view it on GitHub:
#15

[Wardrop]

A lot of parser's also implement it as an option which you have to enable. RedCarpet does this for example, which is probably why Babelmark doesn't indicate it's commonly supported. I'd be happy making it something that's disabled by default. As soon as it's enabled, it becomes the responsibility of the developer to remember and consider this fact.

[simonc]

👍 on the fenced code option. I write my blog with TM2 and the heading style in a code block is just ugly :(

I think a lot of people use it to write Github pages and stuff so it's definitely something needed :)

[Wardrop]

Yeah, my docs in TextMate look like crap now that I'm using fenced code blocks, for the same reason.

[sorbits]

Here’s a “how to” for supporting embedded code in Markdown using { highlight «language» } … { endhighlight }.

1. Select Bundles → Edit Bundles… and select whatever bundle you wish to add to (e.g. a personal bundle or possibly the Markdown bundle, for the latter, make a git clone to ~/Library/Application Support/Avian/Bundles first, if you wish to submit a pull request).

2. Press ⌘N and pick Grammar to create a new grammar.

3. Replace the default grammar with this:

   {  patterns = (
         {  name = 'markup.raw.block.markdown';
            begin = '{% highlight (\w+) %}\n?';
            end = '{% endhighlight %}\n?';
            contentName = 'meta.embedded_$1.markdown';
         },
      );
   }
   

4. Set Injection Selector to L:text.html.markdown. This means the above is injected into Markdown documents, using L:… is to make it “left” of existing rules (i.e. before any other rules).

5. Give the grammar a name and preferably change the Grammar from source.untitled to e.g. injection.markdown.highlight (this field doesn’t presently matter and we have not yet come up with a naming convention, /cc @infininight).

6. Press ⌘S to save the grammar.

7. Close bundle editor (to be sure all changes are saved) and relaunch ⌃⌘Q (presently grammar caches are not flushed when making changes to injected grammars, thus each edit requires a relaunch).

8. Test your changes.

Bonus Section

If you don’t want the injection grammar to show in the status bar (as a selectable grammar) you can edit the .tmGrammar property list saved to ~/Library/Application Support/Avian/Bundles. Add a hideFromUser key to the root dictionary:

<key>hideFromUser</key>
<true/>

If you wish your embedded code to be marked up based on the “language token” provided, then this can be done by injecting into the meta.embedded_«language» scope. Either by doing a dummy grammar that is injected (and includes the corresponding language) or by setting an injection scope selector for the root grammar (@infininight: we got stuck on naming conventions for having these things work out of the box).

To make the above work for fenced code blocks is left as a user exercise :)

[parkr]

@sorbits If I wish to include another pattern for a different block that doesn't have an ending (it's a one-liner), how would my Grammar look? The implementation:

{% include my/subdir/hello.html %}

Right now, my grammar looks like this:

{   patterns = (
        {   name = 'markup.raw.block.markdown';
            begin = '{% include (\w+) %}\n?';
            end = '';
            contentName = 'meta.embedded_$1.markdown';
        },
    );
}

Additionally, how might I expand the injection selector to work with Markdown, Textile and HTML? Perhaps (L:text.html{.markdown,.textile})?

[trvsdnn]

This is real nice.

[sorbits]

Use match instead of begin/end: http://manual.macromates.com/en/language_grammars#rule_keys

As for the scope selector, you can use (L:text.html), that’ll match scopes with that prefix (so includes text.html.markdown, etc.). Alternatively you can use comma to give a list of scope selectors: http://manual.macromates.com/en/scope_selectors

On May 23, 2013, at 20:24, Parker Moore notifications@github.com wrote:

@sorbits If I wish to include another pattern for a different block that doesn't have an ending (it's a one-liner), how would my Grammar look? The implementation:

{% include my/subdir/hello.html %}

Right now, my grammar looks like this:

{ patterns

[parkr]

Brilliant, thank you!!

[Wardrop]

Are we still considering adding this to the Markdown bundle? I think a feature as widely sued and supported as fenced code blocks should be available in TextMate by default, if not enabled by default.

[koenpunt]

I'm using the following for fenced codeblocks:

{   patterns = (
        {   name = 'markup.raw.block.markdown.fenced';
            begin = '(?:^|\G)(?:[`]{3})[ ]*(\w+)?$';
            end = '(^|\G)([`]{3})($|\z)';
            contentName = 'meta.embedded_$1.markdown';
        },
    );
}

I tried applying a grammar to the code in the block by adding:

patterns = ( { include = 'source.$1'; } );

But this doesn't work, got suggestions? Or is this not possible at all?

[sorbits]

Includes are not expanded as format strings.

The idea was to use injections, so for example for the ruby grammar you
can set the injection scope selector to meta.embedded_ruby.markdown,
and that should work.

It’s a bit of a technical challenge to treat includes as format
strings, but I’ll make a note of this use-case.

On 13 Apr 2014, at 1:49, Koen Punt wrote:

I'm using the following for fenced codeblocks:

{ patterns = (
      {   name = 'markup.raw.block.markdown.fenced';
          begin = '(?:^|\G)(?:[`]{3})[ ]*(\w+)?$';
          end = '(^|\G)([`]{3})($|\z)';
          contentName = 'meta.embedded_$1.markdown';
      },
  );
}

I tried applying a grammar to the code in the block by adding:

patterns = ( { include = 'source.$1'; } );

But this doesn't work, got suggestions? Or is this not possible at
all?

---

Reply to this email directly or view it on GitHub:
#15 (comment)