Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mathMakesArt authored Apr 10, 2021
1 parent f6be4f3 commit ba76a45
Showing 1 changed file with 75 additions and 1 deletion.
76 changes: 75 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,78 @@ Template repository for GitHub Pages website creation using JEKETNUNC theme
### Welcome!
If you're reading this, then you may be using the [**jeketnunc-github-pages-template**](https://github.com/jeketnunc/jeketnunc-github-pages-template) repository to create your own GitHub Pages website with the **JEKETNUNC** theme.

Documentation is still in development, and will eventually be included here.
# How to Create your own JEKETNUNC Website

### Step 1: Create a GitHub Account
Visit [**github.com**](https://github.com) and sign up for an account
<br />
<a href="https://mathmakes.art/media/tutorial/jeketnunc/000a-github-homepage.png"><img src="https://mathmakes.art/media/tutorial/jeketnunc/000a-github-homepage.png"></a>
<br />
<br />
<a href="https://mathmakes.art/media/tutorial/jeketnunc/000b-github-create-account.png"><img src="https://mathmakes.art/media/tutorial/jeketnunc/000b-github-create-account.png"></a>
<br />
<br />
<br />
### Step 2: Clone the Template Repository
Visit the [**JEKETNUNC Github Pages Template Repository**](https://github.com/jeketnunc/jeketnunc-github-pages-template) and click the green "**Use this template**" button in the upper right.
<br />
<a href="https://mathmakes.art/media/tutorial/jeketnunc/001-jeketnunc-github-pages-template-use-this-template.png"><img src="https://mathmakes.art/media/tutorial/jeketnunc/001-jeketnunc-github-pages-template-use-this-template.png"></a>
<br />
<br />
<a href="https://mathmakes.art/media/tutorial/jeketnunc/002-create-repo-from-template-blank.png"><img src="https://mathmakes.art/media/tutorial/jeketnunc/002-create-repo-from-template-blank.png"></a>
<br />
Your repository's name must be **your-github-username.github.io** in order to automatically generate a GitHub Pages website.
<br />
The description can contain anything.
<br />
Also, be sure to select the **Public** option.
<br />
Then, you can click **Create repository from template** to generate your own JEKETNUNC website.
<br />
<a href="https://mathmakes.art/media/tutorial/jeketnunc/003-create-repo-from-template-filled-out.png"><img src="https://mathmakes.art/media/tutorial/jeketnunc/003-create-repo-from-template-filled-out.png"></a>
<br />
<br />
<a href="https://mathmakes.art/media/tutorial/jeketnunc/004-generating-your-repository.png"><img src="https://mathmakes.art/media/tutorial/jeketnunc/004-generating-your-repository.png"></a>
<br />
When your repository has generated, you will be presented with the following page:
<br />
<a href="https://mathmakes.art/media/tutorial/jeketnunc/005-newly-created-repository.png"><img src="https://mathmakes.art/media/tutorial/jeketnunc/005-newly-created-repository.png"></a>
<br />
At this point, your website exists as well!
<br />
<br />
<br />
### Step 3: Accessing your Website
You can access your website at a URL which is identical to the name of your repository.
<br />
In the case of this example, that URL is [https://jeketnunc.github.io](https://jeketnunc.github.io), but yours will contain your username instead.
<br />
<a href="https://mathmakes.art/media/tutorial/jeketnunc/006-default-jeketnunc-website.png"><img src="https://mathmakes.art/media/tutorial/jeketnunc/006-default-jeketnunc-website.png"></a>
<br />
The website also contains some placeholder content on the **Primary Art**, **Secondary Art**, and **Unlisted Art** pages.
<br />
You can modify this content by editing the HTML files within your repository's **/_primary/**, **/_secondary/**, and **/_unlisted/** subfolders.
<br />
<a href="https://mathmakes.art/media/tutorial/jeketnunc/007-default-jeketnunc-website-primary.png"><img src="https://mathmakes.art/media/tutorial/jeketnunc/007-default-jeketnunc-website-primary.png"></a>
<br />
<br />
<br />
### Step 4: Using a Custom Domain Name (OPTIONAL)
If you own your own domain name, you can point it to your new GitHub Pages website.
<br />
On your repository's home screen, click the **Settings** tab in the upper right.
<br />
<a href="https://mathmakes.art/media/tutorial/jeketnunc/008-new-repository-from-template-edit-settings.png"><img src="https://mathmakes.art/media/tutorial/jeketnunc/008-new-repository-from-template-edit-settings.png"></a>
<br />
Then, click the **Pages** tab within the navigation pane on the left (near the bottom).
<br />
<a href="https://mathmakes.art/media/tutorial/jeketnunc/009-settings-page-top.png"><img src="https://mathmakes.art/media/tutorial/jeketnunc/009-settings-page-top.png"></a>
<br />
Within this screen, you can enter your own domain name into the **Custom domain** section.
<br />
This will automatically generate a **CNAME** file at the root of your repository.
#### WARNING: In order to successfully point a custom domain to your GitHub Pages site, you must also modify the DNS settings through your domain registrar.
<br />
<a href="https://mathmakes.art/media/tutorial/jeketnunc/010-settings-page-pages-tab.png"><img src="https://mathmakes.art/media/tutorial/jeketnunc/010-settings-page-pages-tab.png"></a>
<br />

0 comments on commit ba76a45

Please sign in to comment.