srhthu / tutorial-github-page

Tutorial of Building Github Pages

Github Pages can host static site. You can build your personal website, project documentations and blogs.

To publish a repository, go to Settings/Pages to config. For example, the repository https://github.com/srhthu/tutorial-github-page will be published at https://srhthu.github.io/tutorial-github-page. Each github account can publish unlimited repositories but only one user page.

Philosophy

Basic

Github page will render the default html file index.html in the repository. It can accessed other files, e.g., main.css or index.js through the relative position.

It may take several minutes to update changes. The building progress can be viewed under Actions

Render with Front-end Framework

The page can be built by frameworks:

• Jekyll (recommended by github) Github doc
• vue
• react
• angular
• hexo: blog framework. web

The repository should be initialized by the corresponding tools.

# To create a new Jekyll site
jekyll new --skip-bundle .

# To create a vue + webpack project
vue init webpack github-page-vue-demo

Change Build Source The default build source is the master branch. It can be changed to the docs folder if exists.

It is useful if you want to build a document website for your project. The repository can include project codes under the <proj_name> folder and website files under docs.

Others

• badges. license; a web intro