Makrdown is not renderred

Issue #14589 closed
Vasyl Boroviak
created an issue

Here is my markdown

# jwt-service
Logic and express.js middleware for handling JWTs.
* Token issuing 
* Token reissuing (refresh)
* Token verification (signature, contents, expiry)

It was rendered this way:

Screen Shot 2017-07-28 at 2.11.32 pm.png

Here is how Github renders it:

Screen Shot 2017-07-28 at 2.13.10 pm.png

Comments (7)

  1. Vasyl Boroviak reporter

    The Markdown editor syntax highlighter does not match the rendered HTML.

    • When a repo has no README.md it shows this button "Create README.md"
    • The button open an editor.

    Problem 1: the editor does not have the "preview" button or I couldn't find it.

    • I typed the Markdown referenced.

    Problem 2: The syntax highlighter of your editor displayed the three list items in a different colour. Thus, I though it would be rendered accordingly.

  2. Alastair Wilkes staff

    Hi there,

    You just need a newline after "JWTs." e.g.

    # jwt-service
    Logic and express.js middleware for handling JWTs.
    
    * Token issuing 
    * Token reissuing (refresh)
    * Token verification (signature, contents, expiry)
    
  3. Vasyl Boroviak reporter

    Hey, Alastair. Thank you. Have you seen the Problem 1 and Problem 2?

    Basically, your UX is so bad that I was tricked by it to use wrong syntax.

    How about being a bit more consistent across the website? :) A "Preview" button in the Markdown editing fields is a great friendly feature. What do you think?

  4. Alastair Wilkes staff

    Yes, Markdown preview would be a great feature! It is captured in issue #3491 if you want to follow that one.

    The syntax highlighting issue is strange - I've opened issue #14706 for that.

    I can definitely see how all these things together provide a suboptimal editing experience. We need to improve that. That said, I'm still going to close this issue as the description has been resolved (and other issues are now captured in separate tickets). Thanks!

  5. Log in to comment