Quang Van Quang Van - 16 days ago 5
Git Question

What's the best way to edit GitHub's Readme.md?

What's the best way to edit GitHub's Readme.md?

I find myself editing the Readme, then I push it, I see mistakes or formatting errors, editing it again, then pushing it...

It really does a number on the commit history.

Is there a better way? Or should I not care about the commit history, and just go bananas on Readme.

Maybe I shouldn't even use Readme at all, but instead use GH pages?




How can I test what my readme.md file will look like before commiting to github? - Just found similar question, but more verbose questions above.

Answer

I just edit the readme on github as a raw file. You can view a preview before you commit the changes.

Comments