Skip to content

Latest commit

 

History

History
143 lines (73 loc) · 4.42 KB

File metadata and controls

143 lines (73 loc) · 4.42 KB

Viewing Markdown Files

Downloading and Installing GitHub Desktop

Instructions to install GitHub Desktop on Ubuntu are given on the GitHub Gist Page GitHub Desktop. The How to Install link on this page, will give commands for other distributions such as Fedora. For Mac, the installer listed on the GitHub Desktop Download Page should be used.

For the Ubuntu install, the first command adds an apt repository:

img_001

Copy and paste it into the terminal:

img_002

As the command is prefixed with sudo, super user do, authentication is required, input your user account password to proceed:

img_003

For the Ubuntu install, the second command updates apt so it refreshes its repositories and installs GitHub Desktop:

img_004

Copy and paste it into the terminal:

img_005

GitHub Desktop is now installed:

img_006

And is available on the Start Screen:

img_007

Select Sign In to GitHub.com:

img_008

Log in on the web browser:

img_009

Select Continue:

img_010

Select Authorise Desktop:

img_011

Check, always allow links and select Open Link:

img_012

Select Finish:

img_013

You will now be logged in:

img_014

Cloning Repository

Select File → Clone Repository:

img_015

Select URL and paste:

https://github.com/PhilipYip1988/python-tutorials

Select Clone:

img_016

Once cloned, the repository will show:

img_017

It is saved within Documents, GitHub:

img_018

img_019

The readme.md displays:

img_020

Downloading and Installing VSCode

To view the formatted markdown, VSCode should be installed. VSCode is a general purpose code editor and has native markdown support. Open up Ubuntu Software and search for VSCode. Select Code:

img_021

Select Install:

img_022

Installation requires use of a super and an authentication prompt will display. Insert your user password and select Authenticate:

img_023

VSCode is now installed and there is a Start Menu shortcut. Select Open:

img_024

Viewing Markdown Files

VSCode will launch, select File → Open Folder:

img_025

img_026

img_027

img_028

Select yes I Trust the Authors:

img_029

Right click the readme.md file and select Open Preview:

img_030

unfortunately the outline which displays the table of contents only displays for the raw file these can eb viewed side by side:

img_031

The file tab can be collapsed and the raw file tab closed, allowing more screen space for the content:

img_032

It is recommended to read these tutorials using two screens. On one screen launch the Spyder IDE and on the other screen, use VSCode for the markdown preview.

Note it is possible to code with Python in VSCode but this requires installation of extensions and setup of a Python environment.

Return to Python Tutorials