0

I use git to upload README documents. What is displayed locally is

enter image description here

After the file is uploaded, it is displayed as:

enter image description here

How can I solve it? Thank you

Improve this question

1 Answer 1

Reset to default
2

Github displays the rendered markdown in readmes as a convenience but it doesn't actually change the content of the file, so the file is still exactly as you uploaded it.

As for the markdown itself, put a blank line after that first header and it should render more correctly.

You may also have to get rid of the leading spaces on your top level numbered list lines but not sure off the top of my head and I'm on my phone right now so can't test easily.

Improve this answer
Sign up to request clarification or add additional context in comments.

1 Comment

I suggest also adding a space between the hashes and the title: #### Directeory. This may be required for rendering, but even if it isn't, it's a lot more readable in raw text form which is a design goal: "The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions."

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.