Skip to content
This repository has been archived by the owner on Mar 27, 2024. It is now read-only.

WIP: Use static site generator #1

Open
wants to merge 20 commits into
base: master
Choose a base branch
from
Open

Conversation

noobymatze
Copy link
Member

@noobymatze noobymatze commented Nov 24, 2017

This pull request ports the huntsearch.org homepage to Hugo. Hugo is a popular static site generator, written in Go.

Why a static site generator?

There are several reasons for choosing a static site generator, instead of a SPA framework like Angular, especially for documentation:

  • SEO: While Google is able to parse JavaScript and execute it, just providing static content is still king for search engine optimization.
  • Consistent organization: Hugo works with a simple and consistent folder organization. So everyone who knows Hugo can just jump straight in. People who don't know Hugo get a crash course in the README.
  • No JavaScript required: Except for interactivity in the documentation itself, the docs are just static content.

Why Hugo?

There are other choices, like AsciiDoc, which has started to become popular for writing documentation, or Hakyll, which is a static site generator, written in Haskell. Ultimately, I just know Hugo and didn't want to fiddle around with compilation rules or port all files from Markdown to AsciiDoc.

Furthermore, the design should be sufficiently simple, that a little bit of custom CSS does the job.

Todos

There are several things still in progress, to get this to a usable state.

  • Style the menu
  • Take a look at the chapters and correct or enhance them, especially concerning the changes with servant.
  • Decide, whether to host it on GitHub or somewhere else.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant