/hs3pl

Hackerspace official public webiste

Primary LanguageHTMLMIT LicenseMIT

hs3pl

Overview

Type: Infrastructure
Purpose: Hackerspace official public webiste
Current maintainer: Allgreed

Contributing

Submit ideas and reporting bugs

  1. Just drop'em as issues :D

Write content

All content is located in ~/content
Markdown knwolegde is required.

  1. Write content
  2. Preview it in development mode
  3. Submit via PR

Look for bugs

  1. Run the app in development mode
  2. Try strange use cases
  3. When you find a bug - submit an issue.

Other / Code

If you'd like to write code please contact the maintainer.

Prerequisites

To begin you'll need to have installed:

Caution! - make sure to install the latest version of Hugo

Setup

  1. Clone the repo

        $ git clone https://github.com/hs3city/inf_main-site
  2. Navigate to the main folder

        $ cd hs3pl

Dev

    hugo serve

Adding new pages

    hugo new PAGENAME.md

Adding items to the menu

Pages

Pages are added automatically, just specify the weight and title in front matter.

External links

To config.toml append following snippet:

    [[menu.main]]
    name = "MENU-ITEM-NAME"
    weight = WEIGHT
    url = "https://example.com"

Where weight is an integer from that describes items order (ascending from the left)

Building

    hugo

The resulting build will be in ~/public

Deploy

    . deploy.sh

deploy.sh requires executive privilages, trash alias (as deleting / moving to trash), hugo alias and push access to hs3city.github.io repository

Shoutout

Based on After Dark theme for Hugo