diff --git a/package.json b/package.json index b80369c35..b947df59f 100644 --- a/package.json +++ b/package.json @@ -116,7 +116,7 @@ "symbols-view": "0.101.0", "tabs": "0.82.0", "timecop": "0.31.0", - "tree-view": "0.183.0", + "tree-view": "0.184.0", "update-package-dependencies": "0.10.0", "welcome": "0.30.0", "whitespace": "0.30.0", diff --git a/src/config.coffee b/src/config.coffee index 7c6dc8286..00ebabf58 100644 --- a/src/config.coffee +++ b/src/config.coffee @@ -283,6 +283,17 @@ ScopeDescriptor = require './scope-descriptor' # __Note__: You should strive to be so clear in your naming of the setting that # you do not need to specify a title or description! # +# Descriptions allow a subset of +# [Markdown formatting](https://help.github.com/articles/github-flavored-markdown/). +# Specifically, you may use the following in configuration setting descriptions: +# +# * **bold** - `**bold**` +# * *italics* - `*italics*` +# * [links](https://atom.io) - `[links](https://atom.io)` +# * `code spans` - `\`code spans\`` +# * line breaks - `line breaks
` +# * ~~strikethrough~~ - `~~strikethrough~~` +# # ## Best practices # # * Don't depend on (or write to) configuration keys outside of your keypath.