GFM Improvements #94

maliayas · 2013-10-27T22:03:19Z

This branch includes further improvements to PR #93. They are about GitHub flavored Markdown and many other details.

Inner highlighting of fenced code blocks implemented. Credit goes to https://github.com/aziz/knockdown/ Screenshot:

This will allow to grey out tags and make the content explicit (with black color).

Extra commas are there for a workaround of ST parsing bug. Without them, ST can't parse multiline scope list correctly.

This feature will be moved to a new syntax file spesific to GFM.

They were the same with the native Markdown plugin's UUDs

Symbol list is a quick TOC of the markdown document. Sublime Text syntax definition files doesn't allow to parse setext syle headers (`====` or `-----`). This makes symbol list non-reliable. This commit makes a workaround. Instead of showing nothing about setext style headers in the symbol list, it shows `====` or `------` part of it. `-----` is displayed indented like `## ` header.

Credit goes to https://github.com/aziz/knockdown. Code is improved a bit.

ttscoff · 2013-10-27T22:30:43Z

Any reason we don't just make this part of the default Markdown settings? I don't see it conflicting with existing stuff and anyone using fenced code blocks isn't going to mind highlighting. This is really good stuff…

maliayas · 2013-10-27T22:42:35Z

Thanks.

GFM doesn't change much things, mostly add new things. "anyone using fenced code blocks isn't going to mind highlighting" approach applies to "anyone using GFM isn't going to mind highlighting", too. So this means we can just remove Markdown.tmLanguage file. I don't agree with this. Instead, maybe we should make GFM syntax default, so when the user installs the plugin, GFM one will be enabled. In fact I tried to do that but somehow wasn't able to do it. Markdown.tmLanguage file was mysteriously overriding Markdown GFM.tmLanguage

ttscoff · 2013-10-27T22:56:13Z

I think maybe we rename Markdown_GFM to Markdown, and Markdown to Markdown_noGFM or something, just to make it easy and avoid having people’s default syntaxes change. It also avoids issues where people who have their own syntax file extension settings that would make them miss the new features and never know it.

maliayas · 2013-10-27T23:00:22Z

Good point. I agree. I'll add a new commit to PR in minutes.

`Markdown.tmLanguage` -> `Markdown (Standard).tmLanguage` `Markdown GFM.tmLanguage` -> `Markdown.tmLanguage` Diff looks terrible, don't mind it.

maliayas · 2013-10-27T23:19:11Z

Weird. It still doesn't work. I'm trying on a freshly installed ST 3. Do you have time to try it?

ttscoff · 2013-10-27T23:48:28Z

Probably not tonight, but I’ll try to test in the morning.

maliayas · 2013-10-27T23:51:13Z

Ok.

It seems the problem is with the native package. When I disable it, it works. Our Markdown.tmLanguage takes presedence over Markdown (Standard).tmLanguage; but native package wins over both. Too weird. Plugins are for overriding. I don't understand why we can't override.

maliayas · 2013-10-28T00:02:37Z

I guess I've found the reason. ST matches .sublime-settings files to .tmLanguage files via their names (I knew this before). So our Packages/User/Markdown.sublime-settings file matches with native plugin's Markdown.tmLanguage file, too. And for some reason native one wins. I can't find a way to set ours as default while the native plugin is enabled.

I hope you can find a way. Otherwise, I guess we will have to write a small script that will run once on plugin update and disable the native plugin.

maliayas · 2013-10-28T00:27:45Z

Last commit is an improvement but still doesn't solve the issue.

I guess they are too similar.

CircleCode · 2013-10-28T07:23:34Z

I think you forgot to reflect syntax files renaming into the readme: readme still references (GFM) syntax file.

Shorcut is changed, too. So, when a text is selected and <kbd>~</kbd> is pressed, text will be surrounded with `~~` instead of `<del>` tag.

Option names are prefixed with `me_`, abbr of "Markdown Editing".

So everything is a tone lighter. Colors are calculated mathematically.

It is optional in GFM.

maliayas · 2013-11-03T22:14:01Z

How is it going? Are we ready to push the update to users?

ttscoff · 2013-11-03T22:30:06Z

Sorry, been a busier weekend than I expected. I'm sure it's all good,
but I'll try to do some testing by tomorrow.

maliayas · 2013-11-03T22:39:12Z

Ok. I've locally created 14 more commits on a branch experiments. I'll publish them today or tomorrow. After we find a solution to overcome the native plugin, I guess we can push the plugin update.

To give a clue, I've implemented an iA Writer feature: keeping current line always vertically centered.

Using Ctrl+B and Ctrl+I directly is not a bad idea if restricted only to markdown. It makes things simpler. I can't see any side effect. OTOH, when a user makes a text bold, the next thing he will do is most of the time moving the cursor to the right of the bold text. This commit implements this. So there is no need of extra key strokes like `right arrow` or `end` keys. We need to keep the user focused on the text, not the key presses. This commit also makes it possible to make a _word_ bold/italic without selecting it. Just move the cursor to the word (at the beginning, in the middle or at the and) and press <kbd>Ctrl</kbd> <kbd>B/I</kbd>. Voila! This makes this scenario possible: * type a word * press <kbd>Ctrl</kbd> <kbd>B</kbd> to make it bold * type space * type next word This means no extra key strokes like <kbd>Left</kbd>, <kbd>Right</kbd>, <kbd>End</kbd>, <kbd>Tab</kbd>. Only relevant key strokes.

It causes some conflicts and doesn't have any improvements over MarkdownEditing plugin.

It was a bad idea :(

maliayas · 2013-11-04T21:19:44Z

It's OK. I've completed my experiments branch and merged it here. I've also written the code to disable the native package. It works like a charm. After your review, you can merge this branch. Don't forget to read the commit descriptions when exists.

Some notes:

Commit bc4a320 makes this possible: (If mentioned plugins are installed)
Commit 7002eaa makes this possible:

This is how GitHub does it:

This looks good with cheat sheets:
Commit 58f0ecf fixes this bug:

... like this:
Commit 1cb52e0 makes it possible to keep current line vertically centered. As the user inserts new lines, current line will stay centered. Users can use this either always or in distraction free mode. It's adjustable in the options. Distraction free mode detection requires another plugin which I've just written for this purpose a few days ago. I believe this feature will improve focusing.

Feedback is always welcome.

Happy Markdown!

maliayas · 2013-11-05T12:11:35Z

I'm planning to create a message file for the update. So users would know what has changed. I've 2 questions:

What do you think the next version number should be? (It affects the file name)
What is the purpose of the packages.json file? I guess package manager doesn't require it.

1. It wont re-apply bold/italic if it already is. 2. It will convert to italic with Ctrl+I even if it is bold at that moment and vice versa.

Background color is inspired from the PlainTasks plugin.

maliayas · 2013-11-15T02:52:48Z

I've created a yellow theme. Here is the screenshot:

Its background color is inspired from the https://github.com/aziz/PlainTasks plugin. The rest is autogenerated by applying a yellow filter to the original grey theme.

CircleCode · 2013-11-19T08:38:10Z

any idea when this pull request could be merged?
I think that if it stays open, commits will always be added to it, since it is always possible to make MarkdownEditing better, but the changes in this PR are really interesting, and I can't wait to see them merged :-)

maliayas · 2013-11-19T11:41:05Z

I was excited, too. But the author looks really really busy. Btw, when he has some time, he will transfer this repository to this organization: https://github.com/SublimeText-Markdown. At least this is what he said 11 days ago. I think an organization would be more productive. This PR is 23 days old, that's too much.

GFM Improvements

maliayas · 2013-11-19T14:25:23Z

Welcome back @ttscoff. It's nice to see you :) I've prepared the plugin for the update and sent a pull request to the Package Control for the URL update.

ttscoff · 2013-11-19T14:38:49Z

Yeah, I've been working 13-15 hour days for a week and a half now. That sprint has cleared up, should be able to help out a little more now, but thanks for taking the reigns. Glad it's moving forward.

oschrenk · 2013-11-19T14:48:47Z

You guys are awesome! Thanks for the work!

maliayas · 2013-11-19T17:06:14Z

Update is online now.

maliayas added 14 commits October 26, 2013 15:21

Improve block level tags detection

3d047f8

Enable HTML parsing inside block level tags

9045f20

This will allow to grey out tags and make the content explicit (with black color).

Grey out only tag parts in xml/html tags, not the whole content

f4a5231

Extra commas are there for a workaround of ST parsing bug. Without them, ST can't parse multiline scope list correctly.

Allow XML/HTML tags inside list paragraphs

f6dd084

Remove fenced code block definition

7e3d5d6

This feature will be moved to a new syntax file spesific to GFM.

Change UUIDs of the syntax files

e1d59e3

They were the same with the native Markdown plugin's UUDs

Fork Markdown.tmLanguage file for the GFM version

baae56b

Create some Markdown files for testing

ce38d78

Implement fenced code blocks with inner syntax highlighting

e8b0ffc

Credit goes to https://github.com/aziz/knockdown. Code is improved a bit.

Changes and refactoring in default settings

3f97588

Add menu command for "Markdown GFM"

fc35652

Update README

964de1e

Define background color for inline code

d5b4720

maliayas mentioned this pull request Oct 27, 2013

Support for Fenced code blocks (GitHub) #12

Closed

Rename syntax files

4eb2ebd

`Markdown.tmLanguage` -> `Markdown (Standard).tmLanguage` `Markdown GFM.tmLanguage` -> `Markdown.tmLanguage` Diff looks terrible, don't mind it.

Regulation of file extension assignments

12398c1

maliayas added 2 commits October 28, 2013 02:53

Update menu

9abb51e

Fork "bold" definition for implementing "strikethrough"

33346d5

I guess they are too similar.

Implement GFM style strikethrough ("~~")

9c95022

Shorcut is changed, too. So, when a text is selected and <kbd>~</kbd> is pressed, text will be surrounded with `~~` instead of `<del>` tag.

maliayas added 7 commits November 3, 2013 00:17

Add option to keep current line centered

1cb52e0

Option names are prefixed with `me_`, abbr of "Markdown Editing".

Improve fenced code blocks

87e1201

Allow HTML/XML in blockquote

38454dc

Make blockquotes lighter

836ea59

Inside blockquotes, lighten some stuff, too

1c2bf33

So everything is a tone lighter. Colors are calculated mathematically.

Make the "space after >" optional for blockquotes

58f0ecf

It is optional in GFM.

Update README

62b9ce6

maliayas added 3 commits November 4, 2013 18:05

Disable native Markdown package automatically on plugin install

efb8653

It causes some conflicts and doesn't have any improvements over MarkdownEditing plugin.

Remove link reference definitions from the symbol list

e34da84

It was a bad idea :(

maliayas added 5 commits November 5, 2013 15:34

Add changelog message for the update

3c5139d

Update README

af942aa

Improve bolding/italicizing feature

0b88b96

1. It wont re-apply bold/italic if it already is. 2. It will convert to italic with Ctrl+I even if it is bold at that moment and vice versa.

Improve update message

69423e5

Add yellow theme

9b57a02

Background color is inspired from the PlainTasks plugin.

ttscoff added a commit that referenced this pull request Nov 19, 2013

Merge pull request #94 from maliayas/gfm

e8f7c7f

GFM Improvements

ttscoff merged commit e8f7c7f into SublimeText-Markdown:master Nov 19, 2013

maliayas deleted the gfm branch November 19, 2013 13:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GFM Improvements #94

GFM Improvements #94

maliayas commented Oct 27, 2013

ttscoff commented Oct 27, 2013

maliayas commented Oct 27, 2013

ttscoff commented Oct 27, 2013

maliayas commented Oct 27, 2013

maliayas commented Oct 27, 2013

ttscoff commented Oct 27, 2013

maliayas commented Oct 27, 2013

maliayas commented Oct 28, 2013

maliayas commented Oct 28, 2013

CircleCode commented Oct 28, 2013

maliayas commented Nov 3, 2013

ttscoff commented Nov 3, 2013

maliayas commented Nov 3, 2013

maliayas commented Nov 4, 2013

maliayas commented Nov 5, 2013

maliayas commented Nov 15, 2013

CircleCode commented Nov 19, 2013

maliayas commented Nov 19, 2013

maliayas commented Nov 19, 2013

ttscoff commented Nov 19, 2013

oschrenk commented Nov 19, 2013

maliayas commented Nov 19, 2013

GFM Improvements #94

GFM Improvements #94

Conversation

maliayas commented Oct 27, 2013

ttscoff commented Oct 27, 2013

maliayas commented Oct 27, 2013

ttscoff commented Oct 27, 2013

maliayas commented Oct 27, 2013

maliayas commented Oct 27, 2013

ttscoff commented Oct 27, 2013

maliayas commented Oct 27, 2013

maliayas commented Oct 28, 2013

maliayas commented Oct 28, 2013

CircleCode commented Oct 28, 2013

maliayas commented Nov 3, 2013

ttscoff commented Nov 3, 2013

maliayas commented Nov 3, 2013

maliayas commented Nov 4, 2013

maliayas commented Nov 5, 2013

maliayas commented Nov 15, 2013

CircleCode commented Nov 19, 2013

maliayas commented Nov 19, 2013

maliayas commented Nov 19, 2013

ttscoff commented Nov 19, 2013

oschrenk commented Nov 19, 2013

maliayas commented Nov 19, 2013