Update README

This commit is contained in:
2024-01-30 08:24:46 +00:00
parent f4b8f0eaa7
commit 752e62724b
2 changed files with 26 additions and 0 deletions

12
.vscode/tasks.json vendored Normal file
View File

@@ -0,0 +1,12 @@
{
"version": "2.0.0",
"tasks": [
{
"type": "hugo",
"task": "server draft",
"group": "build",
"problemMatcher": [],
"label": "hugo: Serve draft site"
}
]
}

View File

@@ -1,8 +1,22 @@
# Leigh Hackspace Website - Hugo Edition # Leigh Hackspace Website - Hugo Edition
Hugo version: 0.122
## Dev Mode ## Dev Mode
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) * Run `hugo serve -D --gc -w -F` (add -F to show content with future dates)
* Goto `http://localhost:1313/` * Goto `http://localhost:1313/`
The site will be updated in realtime with any changes made to the site.
## New Blog Post
* 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.
* Update the `author` and `author_email` values
* Add a `subtitle`
* Run Dev Mode (above), or `make serve` and view your post.