search

denco / vscode-confluence-markup

Visual Studio Code extension for Confluence® markup
MIT License
25 stars 10 forks source link

add language identifier to README.md #10

Closed eponymz closed 5 years ago

eponymz commented 6 years ago

Additionally add in information + example usage snippets for copy/paste directly into vscode.

denco commented 6 years ago

Hi, it's not so good idea to overwrite a standard markdown file extensions (.md) for using it with confluence plugin.

You can do it personally, but in common it's not so usefull.

Additionally confluence plugin register 3 file extensions: .confluence, .wiki and .markup

IMHO it's would better to use registered file extensions instead of overwriting other.

eponymz commented 5 years ago

In VSCode '.mu' isn't a registered file format. It registers as plain text in the editor unless tied to the confluence language identifier. That just makes sure you can still write standard markdown syntax with the file extension '.md' without having to flip flop the language identifiers. I don't mind taking that part out if that is the only issue. The main purpose of this was to get the confluence language identifier added to the README.md to make it easier out of the box for new installations. :)

eponymz commented 5 years ago

I see what you are saying now.. the first example that i added. Got it. Will take that out, it makes sense.

Update Removed reference to the .md file extension and added properly formatted examples with your three listed file extensions as well as the .mu extension.

denco commented 5 years ago

Hi, i don't understand why U document how-to associate a file extensions to language ID's? Association of Language ID is well documented by Microsoft.

Registered file extensions described in Plug In Contributions Tab. file_extensions

For the new ("Untitled") Files U can define a language id in right bottom corner (default is "Plain Text") narrow to "microsoft smile". select_langid

Another way is to press "Ctrl+K M" or what ever... after a Language is defined. VS Code will suggest a registered file extension for this Language ID. change_language

So It's pretty simple to do the things in the right way... ;)

eponymz commented 5 years ago

I added this to your README because that is where people go for information about your project. Not to the contributions tab of another application. The purpose of a README is to make it simple for users to find configuration details. The file extensions you mentioned in your first comment are not standard top VSCode and therefore this would be the first logical place to look when getting your extension configured within VSCode.

denco commented 5 years ago

The point is all of U configuration, except .mu Files is already associated with confluence plugin. U have right peoples read a README to get information of the project, but they should read other information too... Such as what is contribution of plugin...

Sorry but I will reject U pull request and I will close this Topic. Thank U for the providing this Fix, but I see it as useless.

U are welcome to cowork for other issues or feature request, but in a right way:

  1. create an issue for the problem or feature request
  2. create a fix
  3. create pull request.

NOTE: All of this screenshots taked from VSCode Application

  1. extension view of Confluence markup Plugin,
  2. main window
  3. keyboard shortcuts