GitHub – Edit Markdown Files Locally in your IDE

github-logoTo be more productive, you can test your README.md locally and preview it in your IDE.

It’s faster than edit > commit > push > open webbrowser > edit > commit > …)

ScreenShot047

Steps

  1. Install Eclipse and GitHub client
  2. Edit markdown files
  3. Push to GitHub

1. Install Eclipse and GitHub Client

Eclipse IDE can do it > install Eclipse IDE > install GitHub desktop client.

https://www.eclipse.org/downloads/

https://desktop.github.com/

ScreenShot013.png

ScreenShot033.png


2. Edit markdown files

Start Eclipse IDE > Open File ‘YOUR_PROJECT/README.md’ > edit it > … > Click on Preview tab > … > Save

ScreenShot046.png

ScreenShot026

ScreenShot027

ScreenShot025

ScreenShot028

ScreenShot029

ScreenShot030

ScreenShot031


3. Push to GitHub

Start GitHub desktop client > Add message ‘Update README’ > Commit > Push > …wait > go to website to see the result.

ScreenShot045.png

ScreenShot032

ScreenShot034.png

ScreenShot036

ScreenShot040


Source

https://github.com/DamienFremont/blog/tree/master/20170608-github-edit-markdown-files-locally

References

https://www.eclipse.org/downloads/

https://desktop.github.com/

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s