github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-21 20:46:30 -05:00
Code Issues Projects Releases Packages Wiki Activity

Squashed 'docs/' changes from ef9c4913c..d343ebf71

Browse source 
d343ebf71 Document ignoreImports
f912ea1cc Fix the github workflow (#1332)
617894052 Add site function
f3be651f9 Minor typo/markdown fixes (#1328)
7a95e9db5 Fix a formatting error for Github Actions (#1323)
260106669 Fix #1120 Use Github Action
d8847a144 docs: Fix HTML code in .RenderString description being stripped out (#1320)
7a67c38c4 Correct sitemap version (#1318)
6a163f53a Removed noise. (#1317)
b02902121 Fix a minor typo (#1314)
399c74acd Revert "js: Update shims setup"
77def8a8c Revert "Update js.md"
13aeb2c73 Update js.md
704987dc1 js: Update shims setup

git-subtree-dir: docs
git-subtree-split: d343ebf718393ea704da132de508db712f7bcb44
This commit is contained in:
Bjørn Erik Pedersen 2021-02-18 17:52:49 +01:00
parent e48ffb7635
commit acb9109df7
7 changed files with 69 additions and 188 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
content/en/functions/RenderString.md
View file

@ -20,7 +20,7 @@ signature: [".RenderString MARKUP"]
The method takes an optional map argument with these options: The method takes an optional map argument with these options:
display ("inline") display ("inline")
: `inline` or `block`. If `inline` (default), surrounding ´<p></p>` on short snippets will be trimmed. : `inline` or `block`. If `inline` (default), surrounding `<p></p>` on short snippets will be trimmed.
markup (defaults to the Page's markup) markup (defaults to the Page's markup)
: See identifiers in [List of content formats](/content-management/formats/#list-of-content-formats). : See identifiers in [List of content formats](/content-management/formats/#list-of-content-formats).

26
content/en/functions/site.md Normal file
View file

@ -0,0 +1,26 @@
---
title: site
linktitle: site
description: The `site` function provides global access the same data as `.Site` page method
godocref:
date: 2021-02-11
publishdate: 2021-02-11
lastmod: 2021-02-11
keywords: []
categories: [functions]
menu:
docs:
parent: "functions"
toc:
signature: ["site"]
workson: []
hugoversion:
relatedfuncs: ["hugo"]
deprecated: false
draft: false
aliases: []
---
`site` is a global function which returns the same data as the `.Site` page method. See: [Site Variables]({{< relref "/variables/site" >}}).

219
content/en/hosting-and-deployment/hosting-on-github.md
View file

@ -1,10 +1,9 @@
--- ---
title: Host on GitHub title: Host on GitHub
linktitle: Host on GitHub linktitle: Host on GitHub
description: Deploy Hugo as a GitHub Pages project or personal/organizational site and automate the whole process with a simple shell script. 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,12 +13,11 @@ 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/]
--- ---
GitHub provides free and fast static hosting over SSL for personal, organization, or project pages directly from a GitHub repository via its [GitHub Pages service][]. GitHub provides free and fast static hosting over SSL for personal, organization, or project pages directly from a GitHub repository via its [GitHub Pages service][] and automate development workflows and build with [GitHub Actions].
## Assumptions ## Assumptions
@ -29,17 +27,13 @@ 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>/`)
Please refer to the [GitHub Pages documentation][ghorgs] to decide which type of site you would like to create as it will determine which of the below methods to use. Please refer to the [GitHub Pages documentation][ghorgs] to decide which type of site you would like to create as it will determine which of the below methods to use.
To create a User/Organization Pages site, follow the single method in the *GitHub User and Organization Pages* section below.
To create a Project Pages site, choose a method from the *Project Pages* section below.
## GitHub User or Organization Pages ## GitHub User or Organization Pages
As mentioned in the [GitHub Pages documentation][ghorgs], you can host a user/organization page in addition to project pages. Here are the key differences in GitHub Pages websites for Users and Organizations: As mentioned in the [GitHub Pages documentation][ghorgs], you can host a user/organization page in addition to project pages. Here are the key differences in GitHub Pages websites for Users and Organizations:
@ -49,194 +43,50 @@ 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.
### Step-by-step Instructions ## Build Hugo With GitHub Action
1. Create a `<YOUR-PROJECT>` (e.g. `blog`) repository on GitHub. This repository will contain Hugo's content and other source files. GitHub execute your software development workflows. Everytime you push your code on the Github repository, Github Action will build the site automatically.
2. Create a `<USERNAME>.github.io` GitHub repository. This is the repository that will contain the fully rendered version of your Hugo website.
3. `git clone <YOUR-PROJECT-URL> && cd <YOUR-PROJECT>`
4. Paste your existing Hugo project into the new local `<YOUR-PROJECT>` repository. Make sure your website works locally (`hugo server` or `hugo server -t <YOURTHEME>`) and open your browser to <http://localhost:1313>.
5. Once you are happy with the results:
* Press <kbd>Ctrl</kbd>+<kbd>C</kbd> to kill the server
* Before proceeding run `rm -rf public` to completely remove the `public` directory
6. `git submodule add -b main https://github.com/<USERNAME>/<USERNAME>.github.io.git public`. This creates a git [submodule][]. Now when you run the `hugo` command to build your site to `public`, the created `public` directory will have a different remote origin (i.e. hosted GitHub repository).
7. Make sure the `baseURL` in your config file is updated with: `<USERNAME>.github.io`
### Put it Into a Script Create a file in `.github/workflows/gh-pages.yml` containing the following content (based on https://github.com/marketplace/actions/hugo-setup ):
You're almost done. In order to automate next steps create a `deploy.sh` script. You can also make it executable with `chmod +x deploy.sh`. ```yml
name: github pages
The following are the contents of the `deploy.sh` script: on:
push:
branches:
- main # Set a branch to deploy
``` jobs:
#!/bin/sh deploy:
runs-on: ubuntu-18.04
steps:
- uses: actions/checkout@v2
with:
submodules: true # Fetch Hugo themes (true OR recursive)
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
# If a command fails then the deploy stops - name: Setup Hugo
set -e uses: peaceiris/actions-hugo@v2
with:
hugo-version: 'latest'
# extended: true
printf "\033[0;32mDeploying updates to GitHub...\033[0m\n" - name: Build
run: hugo --minify
# Build the project. - name: Deploy
hugo # if using a theme, replace with `hugo -t <YOURTHEME>` uses: peaceiris/actions-gh-pages@v3
with:
# Go To Public folder github_token: ${{ secrets.GITHUB_TOKEN }}
cd public publish_dir: ./public
# Add changes to git.
git add .
# Commit changes.
msg="rebuilding site $(date)"
if [ -n "$*" ]; then
msg="$*"
fi
git commit -m "$msg"
# Push source and build repos.
git push origin main
``` ```
For more advance settings https://github.com/marketplace/actions/hugo-setup
You can then run `./deploy.sh "Your optional commit message"` to send changes to `<USERNAME>.github.io`. Note that you likely will want to commit changes to your `<YOUR-PROJECT>` repository as well.
That's it! Your personal page should be up and running at `https://<USERNAME>.github.io` within a couple minutes.
## GitHub Project Pages
{{% note %}}
Make sure your `baseURL` key-value in your [site configuration](/getting-started/configuration/) reflects the full URL of your GitHub pages repository if you're using the default GH Pages URL (e.g., `<USERNAME>.github.io/<PROJECT>/`) and not a custom domain.
{{% /note %}}
### Deployment of Project Pages from `/docs` folder on `main` branch
[As described in the GitHub Pages documentation][ghpfromdocs], you can deploy from a folder called `docs/` on your main branch. To effectively use this feature with Hugo, you need to change the Hugo publish directory in your [site's][config] `config.toml` and `config.yaml`, respectively:
```
publishDir = "docs"
```
```
publishDir: docs
```
After running `hugo`, push your main branch to the remote repository and choose the `docs/` folder as the website source of your repo. Do the following from within your GitHub project:
1. Go to **Settings** &rarr; **GitHub Pages**
2. From **Source**, select "main branch /docs folder". If the option isn't enabled, you likely do not have a `docs/` folder in the root of your project.
{{% note %}}
The `docs/` option is the simplest approach but requires you set a publish directory in your site configuration. You cannot currently configure GitHub pages to publish from another directory on main, and not everyone prefers the output site live concomitantly with source files in version control.
{{% /note %}}
### Deployment of Project Pages From Your `gh-pages` branch
You can also tell GitHub pages to treat your `main` branch as the published site or point to a separate `gh-pages` branch. The latter approach is a bit more complex but has some advantages:
* It keeps your source and generated website in different branches and therefore maintains version control history for both.
* Unlike the preceding `docs/` option, it uses the default `public` folder.
#### Preparations for `gh-pages` Branch
These steps only need to be done once. Replace `upstream` with the name of your remote; e.g., `origin`:
##### Add the `public` Folder
First, add the `public` folder to your `.gitignore` file at the project root so that the directory is ignored on the main branch:
```
echo "public" >> .gitignore
```
##### Initialize Your `gh-pages` Branch
You can now initialize your `gh-pages` branch as an empty [orphan branch][]:
```
git checkout --orphan gh-pages
git reset --hard
git commit --allow-empty -m "Initializing gh-pages branch"
git push upstream gh-pages
git checkout main
```
#### Build and Deployment
Now check out the `gh-pages` branch into your `public` folder using git's [worktree feature][]. Essentially, the worktree allows you to have multiple branches of the same local repository to be checked out in different directories:
```
rm -rf public
git worktree add -B gh-pages public upstream/gh-pages
```
Regenerate the site using the `hugo` command and commit the generated files on the `gh-pages` branch:
{{< code file="commit-gh-pages-files.sh">}}
hugo
cd public && git add --all && git commit -m "Publishing to gh-pages" && cd ..
{{< /code >}}
If the changes in your local `gh-pages` branch look alright, push them to the remote repo:
```
git push upstream gh-pages
```
##### Set `gh-pages` as Your Publish Branch
In order to use your `gh-pages` branch as your publishing branch, you'll need to configure the repository within the GitHub UI. This will likely happen automatically once GitHub realizes you've created this branch. You can also set the branch manually from within your GitHub project:
1. Go to **Settings** &rarr; **GitHub Pages**
2. From **Source**, select "gh-pages branch" and then **Save**. If the option isn't enabled, you likely have not created the branch yet OR you have not pushed the branch from your local machine to the hosted repository on GitHub.
After a short while, you'll see the updated contents on your GitHub Pages site.
#### Put it Into a Script
To automate these steps, you can create a script with the following contents:
{{< code file="publish_to_ghpages.sh" >}}
#!/bin/sh
if [ "`git status -s`" ]
then
echo "The working directory is dirty. Please commit any pending changes."
exit 1;
fi
echo "Deleting old publication"
rm -rf public
mkdir public
git worktree prune
rm -rf .git/worktrees/public/
echo "Checking out gh-pages branch into public"
git worktree add -B gh-pages public upstream/gh-pages
echo "Removing existing files"
rm -rf public/*
echo "Generating site"
hugo
echo "Updating gh-pages branch"
cd public && git add --all && git commit -m "Publishing to gh-pages (publish.sh)"
#echo "Pushing to github"
#git push --all
{{< /code >}}
This will abort if there are pending changes in the working directory and also makes sure that all previously existing output files are removed. Adjust the script to taste, e.g. to include the final push to the remote repository if you don't need to take a look at the gh-pages branch before pushing.
### Deployment of Project Pages from Your `main` Branch
To use `main` as your publishing branch, you'll need your rendered website to live at the root of the GitHub repository. Steps should be similar to that of the `gh-pages` branch, with the exception that you will create your GitHub repository with the `public` directory as the root. Note that this does not provide the same benefits of the `gh-pages` branch in keeping your source and output in separate, but version controlled, branches within the same repo.
You will also need to set `main` as your publishable branch from within the GitHub UI:
1. Go to **Settings** &rarr; **GitHub Pages**
2. From **Source**, select "main branch" and then **Save**.
## 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.
@ -251,3 +101,4 @@ Refer to the [official documentation for custom domains][domains] for further in
[Quick Start]: /getting-started/quick-start/ [Quick Start]: /getting-started/quick-start/
[submodule]: https://github.com/blog/2104-working-with-submodules [submodule]: https://github.com/blog/2104-working-with-submodules
[worktree feature]: https://git-scm.com/docs/git-worktree [worktree feature]: https://git-scm.com/docs/git-worktree
[GitHub Actions]: https://docs.github.com/en/actions

4
content/en/hugo-modules/configuration.md
View file

@ -80,6 +80,7 @@ extended
[[module.imports]] [[module.imports]]
path = "github.com/gohugoio/hugoTestModules1_linux/modh1_2_1v" path = "github.com/gohugoio/hugoTestModules1_linux/modh1_2_1v"
ignoreConfig = false ignoreConfig = false
ignoreImports = false
disable = false disable = false
[[module.imports]] [[module.imports]]
path = "my-shortcodes" path = "my-shortcodes"
@ -91,6 +92,9 @@ path
ignoreConfig ignoreConfig
: If enabled, any module configuration file, e.g. `config.toml`, will not be loaded. Note that this will also stop the loading of any transitive module dependencies. : If enabled, any module configuration file, e.g. `config.toml`, will not be loaded. Note that this will also stop the loading of any transitive module dependencies.
ignoreImports {{< new-in "0.80.0" >}}
: If enabled, module imports will not be followed.
disable disable
: Set to `true` to disable the module while keeping any version info in the `go.*` files. : Set to `true` to disable the module while keeping any version info in the `go.*` files.

2
content/en/hugo-pipes/js.md
View file

@ -88,7 +88,7 @@ And it will resolve to the top-most `index.{js,ts,tsx,jsx}` inside `assets/my/mo
import { hello3 } from 'my/module/hello3'; import { hello3 } from 'my/module/hello3';
``` ```
Wil resolve to `hello3.{js,ts,tsx,jsx}` inside `assets/my/module`. Will resolve to `hello3.{js,ts,tsx,jsx}` inside `assets/my/module`.
Any imports starting with `.` is resolved relative to the current file: Any imports starting with `.` is resolved relative to the current file:

2
content/en/templates/sitemap-template.md
View file

@ -43,7 +43,7 @@ For multilingual sites, we also create a Sitemap index. You can provide a custom
## Hugo’s sitemap.xml ## Hugo’s sitemap.xml
This template respects the version 1.0 of the [Sitemap Protocol](https://www.sitemaps.org/protocol.html). This template respects the version 0.9 of the [Sitemap Protocol](https://www.sitemaps.org/protocol.html).
```xml ```xml
{{ printf "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?>" | safeHTML }} {{ printf "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?>" | safeHTML }}

2
content/en/variables/site.md
View file

@ -96,7 +96,7 @@ All the methods below, e.g. `.Site.RegularPages` can also be reached via the glo
: top-level directories of the site. : top-level directories of the site.
.Site.Taxonomies .Site.Taxonomies
: the [taxonomies](/taxonomies/usage/) for the entire site. Replaces the now-obsolete `.Site.Indexes` since v0.11. Also see section [Taxonomies elsewhere](#taxonomies-elsewhere). : the [taxonomies](/taxonomies/usage/) for the entire site. Also see section [Taxonomies elsewhere](#taxonomies-elsewhere).
.Site.Title .Site.Title
: a string representing the title of the site. : a string representing the title of the site.