nikdoof/website-hugo
1
0
Fork 0
mirror of https://github.com/nikdoof/website-hugo.git synced 2025-12-13 16:52:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add deployment notes

Browse Source
This commit is contained in:
Andrew Williams
2024-02-10 12:24:27 +00:00
parent 38369b8452
commit 76466b7054
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -9,15 +9,21 @@ To run the site locally you can do the following:
* Download [Hugo extended edition](https://github.com/gohugoio/hugo/releases/) (named hugo_extended). * Download [Hugo extended edition](https://github.com/gohugoio/hugo/releases/) (named hugo_extended).
* Check out repo * Check out repo
* Run `hugo serve -D --gc -w -F` (add -F to show content with future dates) or `make serve` (if you have `make` installed) * Run `hugo serve -D --gc -w -F` (add -F to show content with future dates) or `make serve` (if you have `make` installed)
* Goto `http://localhost:1313/` * Go to `http://localhost:1313/` to view the local instance.
The site will be updated in real-time with any changes made to the site. The site will be updated in real time with any changes made to the site.
## Making Changes ## Making Changes
All changes to the website must be done on a branch and pushed through the GitHub pull requests workflow. If you have any questions about this process then contact the [Tech Infrastructure](https://wiki.leighhack.org/membership/useful_contacts/#tech-infrastructure) people. All changes to the website must be done on a branch and pushed through the GitHub pull requests workflow. If you have any questions about this process then contact the [Tech Infrastructure](https://wiki.leighhack.org/membership/useful_contacts/#tech-infrastructure) people.
## New Blog Post ## Deployment
Branches are automatically deployed to [https://web-test.leighhack.org](https://web-test.leighhack.org) with subfolders for each of the branches in the repository. Once merged into `main` it'll be deployed out to the live website.
## Common Tasks
### New Blog Post
* Download and install Hugo * Download and install Hugo
* Run `hugo new blog/<year>/name-of-post/index.md`, and a new file will be created in the right folder. * Run `hugo new blog/<year>/name-of-post/index.md`, and a new file will be created in the right folder.