Skip to content

Latest commit

 

History

History
52 lines (36 loc) · 2.39 KB

README.md

File metadata and controls

52 lines (36 loc) · 2.39 KB
Raw

Space-Wizards Hugo

This is the Hugo content used to build the website. You will obviously need to have hugo installed and on your PATH. Since I don't expect you to read Hugo's documentation to make a blog post I'll quickly write some stuff down for you here.

First though you need to init Git submodules so do that:

$ git submodule init

Building

You will need to have npm installed to build the website (CSS stuff, mostly). Once you have that run npm install in the project directory to let npm fetch the dependencies like bootstrap.

To build the site, run $ hugo inside the project. That's it. This dumps the output files into the /public/ folder. This isn't really practical for making sure your site's up to scratch though. If you want that, run $ hugo serve instead. It'll create a local (automatically updating) web server that you can connect to to make sure everything checks out.

The website automatically updates when master is pushed.

Writing Posts 101

To add a post, simply create a markdown file under /content/post/ that ends in .md. Sane naming please. Inside this file will be the content of the page, along with some other stuff defining title, date of creation, etc...

The content is just regular markdown, the title and stuff however is called "front matter" and is written in TOML inside +++ at the top of the markdown file.Tt looks like this:

+++
title = "doodad" # Title. Duh.
date = 1970-01-30 # Time. As this is TOML, any TOML date-time will do: https://github.com/toml-lang/toml#offset-date-time
author = "Urist McDude" # Your name.
reddit = "https://reddit.com/link/to/reddit/thread" # Optional, when provided with a link it'll show as "Join the discussion on Reddit" below the article.
tags = [
	"tag1",
	"tag2",
	...
]

categories = [
	"cat1",
	"cat2",
	...
]
# Google the difference between categories and tags, seriously Google results give much better results than I can explain here.
+++

Hi, I'm a blog post!

<!--more-->

And I'm behind the "Read more..." section! Clickbait!

Also important is the summary split, <!--more-->. Put this where you want the summary on the main page listing to split with a "Read More..." link. This happens automatically with Hugo, but Hugo isn't exactly smart about it so I advise you you do it yourself. See Hugo's documentation