Skip to content

Latest commit

 

History

History
145 lines (74 loc) · 3.99 KB

File metadata and controls

145 lines (74 loc) · 3.99 KB

Viewing Markdown Files

Downloading and Installing GitHub Desktop

GitHub Desktop can be downloaded from GitHub Desktop Download:

img_001

Launch the installer:

img_002

img_003

Select Sign In to GitHub.com:

img_004

Enter you account details:

img_005

Select Continue:

img_006

Check Always Allow GitHub.com to open links of this type and select Open:

img_007

Select Finish:

img_008

Cloning Repository

Select File → Clone Repository:

img_009

Select URL and paste:

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

Select Clone:

img_010

Once cloned, the repository will show:

img_011

It is saved within Documents, GitHub:

img_012

And python-tutorials:

img_013

The readme.md displays:

img_014

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. VSCode can be downloaded from the VSCode Download Page. Select Windows (this will default to the User Installer):

img_015

img_016

Launch the VSCode setup:

img_017

Accept the License Agreement and select Next:

img_018

Select the default location and select Next:

img_019

Select Next:

img_020

Use the default options and select Next:

img_021

Select Install:

img_022

Select Finish:

img_023

Viewing Markdown Files

VSCode will launch, select File → Open Folder:

img_024

Navigate to Python Tutorials and select Open:

img_025

Select yes I Trust the Authors:

img_026

Clicking on the readme.md will open the markdown editor:

img_027

The table of contents display in the Outline:

img_028

Right click the file and select Open Preview:

img_029

This will display the formatted document:

img_030

unfortunately the Outline is blank when the Preview is selected. The raw file and the preview can be opened side by side, allowing use of the outline:

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