I honestly consider this and obviously an almost nonsense post, but I just noticed: enter image description here Should those Styling/Headers Markdown Editing Help Examples Be an Actual Example?
enter image description here
I know they are intentionally created as non-actual example as the web developer
have used a <pre> Preformatted Text tag

  • 1
    Why shouldn't they be? The text demonstrates the actual Markdown syntax used. – Martijn Pieters Mar 2 '14 at 10:05
  • I don't understand your question. If the text was formatted, you wouldn't see the markdown, which would make the example useless. Are you suggesting that they put both the markdown and the "preview"? – Mat Mar 2 '14 at 10:06
  • Yes, exactly... – Dadan Mar 2 '14 at 10:08
  • Exactly what? Please edit your question to make it clearer what you're suggesting. – Mat Mar 2 '14 at 10:10
  • So why shouldn't this be an actual example? What did you expect to see instead and how would a user discover what Markdown syntax to use for those stylings? – Martijn Pieters Mar 2 '14 at 10:10

I am getting your point, you're trying to say that the example of the code should be provided too. Such as:

"This is italicized, and so is this." is result of: *This is italicized*, and so is _this_.

So that people who lack enough knowledge of English language (for example and most importantly ME), never knows what is meant by italic. I first thought this is something related to Italy or something like that, but then I came to know it means the Pisa; the Leaning tower! :-P

Your idea is a good one, but I think, it is better to add both the elements, one that would show the operator and other would give a real time example of the code being used. But using the pre tag is not of usage here. Just a simple example would do it for the newbie. And once you're a regular user, you won't even need the Help! :) You'll memorize it.

| improve this answer | |
  • Yes thats why I know my question is really very minor design-need – Dadan Mar 2 '14 at 10:13
  • Yes, but that's a need of the newbie! They need to understand what the site is and how can you format your post. You really need help, even I did... – Afzaal Ahmad Zeeshan Mar 2 '14 at 10:14

You must log in to answer this question.

Not the answer you're looking for? Browse other questions tagged .