Developing GitHub Pages on Windows 10
This guide demonstrates how to create a GitHub pages site. A GitHub pages site can be used to create static web pages for documentation, blogs or tutorials
Creating a GitHub pages repository
-
On GitHub create a new repository. Your web site will have a URL that looks like https://username.github.io/repository-name
-
On the Create a New Repository page, add a .gitignore for Jekyll. Jekyll is a tool that GitHub uses to convert markdown text into html web pages.
-
Open the repository settings page:
-
Make this repository a GitHub Pages project by scrolling down to the GitHub pages section and setting the source to the master branch.
-
Set the GitHub pages theme.
Clone the repository
Using GitHub Desktop or your favourite git client, clone the repository
Add a landing page
The default landing page for a GitHub Pages project is typically generated from a file named index.md - open Visual Studio Code onto the cloned repository.
Add a file called index.md and create content in markdown. Visual Studio Code comes built in with a previewer for markdown code so you can get a feel for what it will look like.
You can use markdown to link to other markdown files in your repository as well to build a static website.
When you have finished, you can commit and push the changes back to GitHub. After a few moments, you should see the updated page at github.io - 