Genius/hextra
1
0
Fork 0
forked from drowl87/hextra_mirror
Code Pull Requests Activity

docs: minor update deploy site doc

Browse Source
This commit is contained in:
Xin 2023-10-31 09:14:46 +00:00
parent e3f6069968
commit 9d68f7c71a
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
exampleSite/content/docs/guide/deploy-site.md
View File

@ -14,11 +14,11 @@ This page provides guides for deploying your Hextra site on various platforms.
[GitHub Pages](https://docs.github.com/pages) is the recommended way to deploy and host your website for free. [GitHub Pages](https://docs.github.com/pages) is the recommended way to deploy and host your website for free.
If you bootstrap the site using [hextra-starter-template][hextra-starter-template], it has provided GitHub Actions workflow out-of-the-box that helps automatically deploy to GitHub Pages. If you bootstrap the site using [hextra-starter-template](https://github.com/imfing/hextra-starter-template), it has provided GitHub Actions workflow out-of-the-box that helps automatically deploy to GitHub Pages.
{{% details title="GitHub Actions Configuration" closed="true" %}} {{% details title="GitHub Actions Configuration" closed="true" %}}
Below is an example configuration from [hextra-starter-template][hextra-starter-template]: Below is an example configuration from [hextra-starter-template](https://github.com/imfing/hextra-starter-template):
```yaml {filename=".github/workflows/pages.yaml"} ```yaml {filename=".github/workflows/pages.yaml"}
# Sample workflow for building and deploying a Hugo site to GitHub Pages # Sample workflow for building and deploying a Hugo site to GitHub Pages
@ -104,7 +104,7 @@ jobs:
![](https://user-images.githubusercontent.com/5097752/266784808-99676430-884e-42ab-b901-f6534a0d6eee.png) ![](https://user-images.githubusercontent.com/5097752/266784808-99676430-884e-42ab-b901-f6534a0d6eee.png)
{{< /callout >}} {{< /callout >}}
By default, the above GitHub Actions workflow assumes that the site is deploying to `https://<USERNAME>.github.io/<REPO>/`. By default, the above GitHub Actions workflow `.github/workflows/pages.yaml` assumes that the site is deploying to `https://<USERNAME>.github.io/<REPO>/`.
If you are deploying to `https://<USERNAME>.github.io/` then modify the `--baseURL`: If you are deploying to `https://<USERNAME>.github.io/` then modify the `--baseURL`:
@ -158,6 +158,4 @@ Check [Hugo on Netlify](https://docs.netlify.com/integrations/frameworks/hugo/)
1. Set Build Command to `hugo --gc --minify` 1. Set Build Command to `hugo --gc --minify`
2. Set Install Command to `yum install golang` 2. Set Install Command to `yum install golang`
![image](https://github.com/imfing/hextra/assets/5097752/887d949b-8d05-413f-a2b4-7ab92192d0b3) ![Vercel Deployment Configuration](https://github.com/imfing/hextra/assets/5097752/887d949b-8d05-413f-a2b4-7ab92192d0b3)
[hextra-starter-template]: https://github.com/imfing/hextra-starter-template