TheCloud/hugoDocs
1
0
Fork 0
mirror of https://github.com/gohugoio/hugoDocs.git synced 2025-09-14 08:34:42 -04:00
Code Issues Packages Projects Releases Wiki Activity

Minor typo/markdown fixes (#1328)

Browse Source 
For https://gohugo.io/hosting-and-deployment/hosting-on-github/
This commit is contained in:
Christian Oliff 2021-02-08 13:12:44 +09:00 committed by GitHub
parent 7a95e9db57
commit f3be651f9c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
content/en/hosting-and-deployment/hosting-on-github.md
View File

@ -4,7 +4,6 @@ linktitle: Host on GitHub
description: Deploy Hugo as a GitHub Pages project or personal/organizational site and automate the whole process with Github Action Workflow description: Deploy Hugo as a GitHub Pages project or personal/organizational site and automate the whole process with Github Action Workflow
date: 2014-03-21 date: 2014-03-21
publishdate: 2014-03-21 publishdate: 2014-03-21
lastmod: 2018-09-22
categories: [hosting and deployment] categories: [hosting and deployment]
keywords: [github,git,deployment,hosting] keywords: [github,git,deployment,hosting]
authors: [Spencer Lyon, Gunnar Morling] authors: [Spencer Lyon, Gunnar Morling]
@ -14,7 +13,6 @@ menu:
weight: 30 weight: 30
weight: 30 weight: 30
sections_weight: 30 sections_weight: 30
draft: false
toc: true toc: true
aliases: [/tutorials/github-pages-blog/] aliases: [/tutorials/github-pages-blog/]
--- ---
@ -29,7 +27,7 @@ GitHub provides free and fast static hosting over SSL for personal, organization
## Types of GitHub Pages ## Types of GitHub Pages
There are 2 types of GitHub Pages: There are two types of GitHub Pages:
- User/Organization Pages (`https://<USERNAME|ORGANIZATION>.github.io/`) - User/Organization Pages (`https://<USERNAME|ORGANIZATION>.github.io/`)
- Project Pages (`https://<USERNAME|ORGANIZATION>.github.io/<PROJECT>/`) - Project Pages (`https://<USERNAME|ORGANIZATION>.github.io/<PROJECT>/`)
@ -45,15 +43,13 @@ As mentioned in the [GitHub Pages documentation][ghorgs], you can host a user/or
This is a much simpler setup as your Hugo files and generated content are published into two different repositories. This is a much simpler setup as your Hugo files and generated content are published into two different repositories.
## Build Hugo With GitHub Action
## Build Hugo With Github Action
GitHub execute your software development workflows. Everytime you push your code on the Github repository, Github Action will build the site automatically. GitHub execute your software development workflows. Everytime you push your code on the Github repository, Github Action will build the site automatically.
Create a file in `.github/workflows/gh-pages.yml` containing the following content (based on https://github.com/marketplace/actions/hugo-setup ): Create a file in `.github/workflows/gh-pages.yml` containing the following content (based on https://github.com/marketplace/actions/hugo-setup ):
``` ```yml
name: github pages name: github pages
on: on:
@ -95,7 +91,7 @@ For more advance settings https://github.com/marketplace/actions/hugo-setup
## Use a Custom Domain ## Use a Custom Domain
If you'd like to use a custom domain for your GitHub Pages site, create a file `static/CNAME`. Your custom domain name should be the only contents inside `CNAME`. Since it's inside `static`, the published site will contain the CNAME file at the root of the published site, which is a requirements of GitHub Pages. If you'd like to use a custom domain for your GitHub Pages site, create a file `static/CNAME`. Your custom domain name should be the only contents inside `CNAME`. Since it's inside `static`, the published site will contain the CNAME file at the root of the published site, which is a requirement of GitHub Pages.
Refer to the [official documentation for custom domains][domains] for further information. Refer to the [official documentation for custom domains][domains] for further information.