Merge branch '3.1.1' into st4-3.1.1

CONTRIBUTING.md

@@ -105,9 +105,6 @@ Here are the used scopes under 3 different markdown flavors. If you are not sure
 * punctuation.definition.string.end.markdown
 * punctuation.definition.string.markdown
 * punctuation.separator.key-value.markdown
-* string.other.link.description.markdown
-* string.other.link.description.title.markdown
-* string.other.link.title.markdown
 
 ### ScopeName: text.html.markdown.gfm
 
@@ -168,9 +165,6 @@ Here are the used scopes under 3 different markdown flavors. If you are not sure
 * __punctuation.definition.tag.begin.html__
 * __punctuation.definition.tag.end.html__
 * punctuation.separator.key-value.markdown
-* string.other.link.description.markdown
-* string.other.link.description.title.markdown
-* string.other.link.title.markdown
 
 ### ScopeName: text.html.markdown.multimarkdown
 

Default (Linux).sublime-keymap

@@ -1188,7 +1188,7 @@
 	// jump to reference
 	{ "keys": ["f12"], "command": "mde_reference_jump", "context":
 		[
-			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown meta.link.reference string.other.link", "match_all": true }
+			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown meta.link.reference", "match_all": true }
 		]
 	},
 	{ "keys": ["shift+f12"], "command": "mde_reference_jump", "context":

Default (OSX).sublime-keymap

@@ -1188,7 +1188,7 @@
 	// jump to reference
 	{ "keys": ["f12"], "command": "mde_reference_jump", "context":
 		[
-			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown meta.link.reference string.other.link", "match_all": true }
+			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown meta.link.reference", "match_all": true }
 		]
 	},
 	{ "keys": ["shift+f12"], "command": "mde_reference_jump", "context":
@@ -1379,31 +1379,31 @@
 	// Wiki
 	//
 
-	{ "keys": ["super+shift+h"], "command": "mde_open_home_page", "context":
+	{ "keys": ["super+alt+h"], "command": "mde_open_home_page", "context":
 		[
 			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown", "match_all": true },
 			{ "key": "setting.mde.keymap_disable.open_home_page", "operator": "not_equal", "operand": true }
 		]
 	},
-	{ "keys": ["super+shift+d"], "command": "mde_open_page", "context":
+	{ "keys": ["super+alt+d"], "command": "mde_open_page", "context":
 		[
 			{ "key": "selector", "operator": "equal", "operand": "meta.link.reference.wiki.description.markdown", "match_all": true },
 			{ "key": "setting.mde.keymap_disable.open_page", "operator": "not_equal", "operand": true }
 		]
 	},
-	{ "keys": ["super+shift+d"], "command": "mde_make_page_reference", "context":
+	{ "keys": ["super+alt+d"], "command": "mde_make_page_reference", "context":
 		[
 			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown - (meta.link | markup.underline.link)", "match_all": true },
 			{ "key": "setting.mde.keymap_disable.make_page_reference", "operator": "not_equal", "operand": true }
 		]
 	},
-	{ "keys": ["super+shift+x"], "command": "mde_list_back_links", "context":
+	{ "keys": ["super+alt+x"], "command": "mde_list_back_links", "context":
 		[
 			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown", "match_all": true },
 			{ "key": "setting.mde.keymap_disable.list_back_links", "operator": "not_equal", "operand": true }
 		]
 	},
-	{ "keys": ["super+shift+j"], "command": "mde_open_journal", "context":
+	{ "keys": ["super+alt+j"], "command": "mde_open_journal", "context":
 		[
 			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown", "match_all": true },
 			{ "key": "setting.mde.keymap_disable.open_journal", "operator": "not_equal", "operand": true }

Default (Windows).sublime-keymap

@@ -1188,7 +1188,7 @@
 	// jump to reference
 	{ "keys": ["f12"], "command": "mde_reference_jump", "context":
 		[
-			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown meta.link.reference string.other.link", "match_all": true }
+			{ "key": "selector", "operator": "equal", "operand": "text.html.markdown meta.link.reference", "match_all": true }
 		]
 	},
 	{ "keys": ["shift+f12"], "command": "mde_reference_jump", "context":

Preferences.sublime-settings

@@ -40,6 +40,16 @@
 	// Adds <Tab> after list items instead of a single <space>.
 	"mde.list_align_text": false,
 
+	// MarkdownEditing (References):
+	// The sorting method used by the Organize References command.
+	// Should be one of
+	//
+	// "reference_order": List in order of appearance in document
+	// "alphabetical": Alphabetical based on reference name, sorting numerals lexagraphically
+	// "numeric": Alphabetical based on reference name, sorting numeral chunks numerically
+	"mde.ref_organize_sort": "reference_order",
+	"mde.ref_organize_sort_reverse": false,
+
 	// MarkdownEditing:
 	// Automatically switches list bullet when indenting blank list item with <Tab>.
 	"mde.list_indent_auto_switch_bullet": true,

docs/troubleshooting.md

@@ -27,7 +27,7 @@ To clean up or restore syntax specific settings...
    a) To clean up, remove no longer needed overrides.  
    b) To restore, paste desired settings from following code block.
 
-```json
+```jsonc
 {
     "color_scheme": "MarkdownEditor.sublime-color-scheme",
     "tab_size": 4,
@@ -126,10 +126,16 @@ When you notice any undesired behaviour introduced by the latest update, your fe
 
 ## Known Bugs
 
-* Setext-style headers (`===` and `---`) do not show up in the symbol list. This is due to a Sublime Text limitation (see [#158][]). However, we are able to put a placeholder to indicate the existence of the header. We encourage you to use Atx-style headers (`#`).
+* Setext-style headers (`===` and `---`) show up in the symbol list of Sublime Text 4 only.  
+  They are not supported by Sublime Text 3 (see [#158][]).
+
+* Indended code block highlighting in list blocks is not supported (see [#663][]).  
+  ST's syntax engine can't count indentation, so reliably highlighting indended code blocks in
+  maybe nested list items is impossible. Use fenced code blocks instead.
 
 * Installing for the first time while having markdown files opened may cause MarkdownEditing to behave unexpectedly on those files. Close and reopen those files to fix it.
 
 [#158]: https://github.com/SublimeText-Markdown/MarkdownEditing/issues/158
+[#663]: https://github.com/SublimeText-Markdown/MarkdownEditing/issues/663
 [mdereleases]: https://github.com/SublimeText-Markdown/MarkdownEditing/releases
 [mdeissues]: https://github.com/SublimeText-Markdown/MarkdownEditing/issues

docs/usage.md

@@ -344,7 +344,9 @@ Lastly the command to open the *home* page is provided, where the home page is j
 
 | Linux/Windows | MacOS | Description
 |---------------|-------|-------------
-| <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>H</kbd> | <kbd>⌘</kbd> + <kbd>⌥</kbd> + <kbd>H</kbd> | Open home page
-| <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>D</kbd> | <kbd>⌘</kbd> + <kbd>⌥</kbd> + <kbd>D</kbd> | Open wiki page under the cursor
-| <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>J</kbd> | <kbd>⌘</kbd> + <kbd>⌥</kbd> + <kbd>J</kbd> | Open journal page for today
-| <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>B</kbd> | <kbd>⌘</kbd> + <kbd>⌥</kbd> + <kbd>B</kbd> | List back links
+| <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>H</kbd> | <kbd>⌘</kbd> + <kbd>⌥</kbd> + <kbd>H</kbd> | Open home page
+| <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>D</kbd> | <kbd>⌘</kbd> + <kbd>⌥</kbd> + <kbd>D</kbd> | Open wiki page under the cursor
+| <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>J</kbd> | <kbd>⌘</kbd> + <kbd>⌥</kbd> + <kbd>J</kbd> | Open journal page for today
+| <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>X</kbd> | <kbd>⌘</kbd> + <kbd>⌥</kbd> + <kbd>B</kbd> | List back links
+
+_Note: The key bindings are disabled via Preferences by default to prevent conflicts with certain keyboard layouts._

make.cmd

@@ -41,7 +41,7 @@ goto :usage
 
 :LINT
     call :venv
-    black --check .
+    black .
     flake8
     goto :eof
 

messages.json

@@ -33,5 +33,7 @@
 	"3.0.4": "messages/3.0.4.md",
 	"3.0.5": "messages/3.0.5.md",
 	"3.0.6": "messages/3.0.6.md",
-	"3.0.7": "messages/3.0.7.md"
+	"3.0.7": "messages/3.0.7.md",
+	"3.1.0": "messages/3.1.0.md",
+	"3.1.1": "messages/3.1.1.md"
 }

messages/3.1.1.md

@@ -6,9 +6,30 @@ feedback you can use [GitHub issues][issues].
 ## Bug Fixes
 
 * fix regression with latex block highlighting in list items
+* fix CommonMark compatibility of backslash escapes
+* fix CommonMark compatibility of block quotes
+* fix CommonMark compatibility of html entities
+* fix CommonMark compatibility of fenced code blocks
+* fix CommonMark compatibility of indented code blocks (mixed tabs/spaces)
+* fix CommonMark compatibility of reference definitions
+* fix CommonMark compatibility of thematic breaks
+* fix `mde_convert_inline_link_to_reference` producing duplicate definitions (fixes #559)
+* update strikethough markup to use 2 tildes (fixes #637)
+* restore link/image/reference description colors for Mariana/Monokai (fixes #670)
+* fix strikethrough colors in Monokai/Mariana (fixes #678)
+* fix wiki link bindings and their docs (see #679)
 
 ## New Features
 
+* `Organize References` learned to sort reference definitions using `"mde.ref_organize_sort"` setting
+
 ## Changes
 
+* Fully support xonsh fenced code instead of using Python syntax 
+  (if supported syntax is installed)
+* Removes indended code block highlighting from list blocks (fixes #663)
+  ST's syntax engine can't count indentation, so reliably highlighting
+  indended code blocks in maybe nested list items is impossible.
+  Use fenced code blocks instead.
+
 [issues]: https://github.com/SublimeText-Markdown/MarkdownEditing/issues