Search code examples
markdowngithub-flavored-markdown

Using italic in markdown for words that end with a star

I'm not quite sure where to ask this question and whether StackOverflow is the right place, so please apologize if it is not. Anyway, although my question is not directly related to programming itself, it concerns a task that is related to programming: Writing documentation.

I write documentation using GitHub-Flavored Markdown, and in one document on web services I am using the term WS-*. Now I want to emphasize this term by making it italic, so usually I do this like this:

*foo*

The problem with WS-* now is that it already ends with a star, so I get:

*WS-**

Which is not correctly recognized by my Markdown parser, as it interpretes this as open italic and close bold.

How can I correctly write this in valid Markdown, that is compatible to the standard (and hence works with standard-compliant parsers)?

Solution

  • Use _single underscores_ like this:

     _WS-*_

    It results in 

     <em>WS-*</em>

    It's standard-compliant.