Getting started
If you’re not familiar with Github Pages check out the official documentation to know how it works.
Go to your Github repository and follow this guide to get it up and running.
Using template remotely
Simply set the remote_theme
value in your _config.yml
file.
remote_theme: nikahmadz/pages
- Open your site’s repository. Edit the content of
_config.yml
file. - Remove existing values of
theme
andremote_theme
and set the new value as above. - Then activate Github Pages.
Activating Github Pages
Go to Github Pages Settings of your repository.
//github.com/<user-name>/<repo-name>/settings/pages
- Scroll down to the Source section.
- Choose the source of your website. eg:
main/(root)
- Click Save.
- Your app will be accessible at
//<user-name>.github.io/<repo-name>
.
Writing content
Github Pages uses Jekyyll to build your website. Familiarize your self on the basics of front-matter, writing posts, and creating pages.
On every content you create, start with the following front-matter. If you don’t specify the value, default is used.
---
layout: layout-name
title: "Title of the article"
description: "Short description for the article."
site_title: # (optional: false) will hide first <h1>
permalink: # (optional: permalink)
---
Using markdown
Markdown is a lightweight and easy-to-use syntax for styling your content. It includes …
Syntax highlighted code block
# Header 1
## Header 2
### Header 3
- Bulleted
- List
1. Numbered
2. List
**Bold** and _Italic_ and `Code` text
[Link](url) and ![Image](src)
For more details see basic writing and formatting syntax.