Template for a Github Pages web site using GitHub API
- Fork this project in your Github account
- Activate Github pages in the Github repository settings
- Using your USERNAME
- Go to https://github.com/USERNAME/github-pages-template/settings
- Go to the section "Github Pages"
- Select source "master branch"
- Press "Save" button
- Rename your project to your GitHub Pages URL
- Using your USERNAME
- Go to https://github.com/USERNAME/github-pages-template/settings
- Change
github-pages-templatetoUSERNAME.github.ioand save
- Wait for one minute and point your browser to https://USERNAME.github.io/
You're done!! Now you have an automatically generated Github Page
You can add some extra configuration in the file ./config.js
You can add some featured repositories following this steps:
- Edit the file
./featured.js, adding a github project name, and uploading a screenshot to theimages/folder.
'my-repository-name' : {
image:"images/repository-screenshot.png"
},
In this example, two projects are added to the "Featured" section
var myRepos =
{
'my-repo1' : {
image:"images/image1.png"
},
'my-repo2' : {
image:"images/image2.png"
},
}If you want to use this page template outside the github.io domain, you can change this line in js/config.js to select the default 'github' user to your user name or any other:
if (!myUser){
myUser = "github";
} https://fraigo.github.io/github-pages-template/
https://fraigo.github.io/github-pages-template/?username
Examples:
Feel free to contribute to this project submitting bugs and new features.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent