CODEWITHSUNDEEP
githubgithub-flavored-markdown
Mark Harrison
Mark Harrison

Reputation: 304662

Previewing local Github README.md changes?

How do I preview changes to README.md in my local client, prior to committing and pushing to Github?

Upvotes: 3

Views: 1400

Answers (3)

Bruno Qualhato
Bruno Qualhato

Reputation: 11

See this

Nome: node-readme ID: bengreenier.vscode-node-readme Descrição: A vscode extension to view javascript module documentation in editor. Versão: 3.0.2 Editor: bengreenier Link do Marketplace do VS: https://marketplace.visualstudio.com/items?itemName=bengreenier.vscode-node-readme

Upvotes: 1

Arnooo
Arnooo

Reputation: 244

You can go to gist.github.com and create a README.md file.

github gist readme preview

Now you can write into textarea, and preview changes by clicking on the tab. Note that isn't necessary to commits changes.

Upvotes: 3

ScottWelker
ScottWelker

Reputation: 2104

You'll require an editor that provides the preview feature or some other third-party tool.

Upvotes: 0

Related Questions