Git
/
hugo-story
mirror of https://github.com/caressofsteel/hugo-story.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity
A (modular, highly tweakable) responsive one-page theme for Hugo.
28 Commits 1 Branch 0 Tags 37 MiB
HTML 81.5%
SCSS 14.3%
JavaScript 4.2%
Go to file
Thomas Jungbauer 07542e475f
added breakpint: null and removed deprecated !global 		2022-09-26 09:24:12 +02:00
assets added breakpint: null and removed deprecated !global 2022-09-26 09:24:12 +02:00
exampleSite moving config.toml to exampleSite and removing other configs 2021-02-04 17:37:54 +01:00
images First Commit - Hugo Story 2020-07-02 01:05:45 -04:00
layouts added id to gallery partial 2022-07-29 20:04:46 +02:00
originalStorySite moving config.toml to exampleSite and removing other configs 2021-02-04 17:37:54 +01:00
static First Commit - Hugo Story 2020-07-02 01:05:45 -04:00
LICENSE First Commit - Hugo Story 2020-07-02 01:05:45 -04:00
README.md change "add" to "clone" 2022-06-02 11:34:07 -07:00
theme.toml First Commit - Hugo Story 2020-07-02 01:05:45 -04:00

README.md

Hugo Story

A (modular, highly tweakable) responsive one-page theme for Hugo.

Hugo Story is a port of the static HTML template Story by HTML5 UP. It is designed to mirror the look and feel of the original template as closely as possible while incorporating some of the features Hugo has to offer.

This theme is designed for those who are comfortable editing HTML and integrating Hugo short codes and variables to customize the theme to their liking.

Features

  • Minimalist Design
  • Fully Responsive
  • Templates
    • Header
    • Footer
    • FootScripts
    • Favicon
  • Partials for each element type
    • Banner
    • Spotlight
    • Gallery
    • Items
  • Image gallery
  • Short Codes
    • Site Title
    • Site Subtitle
    • Site Logo
    • Social Icons
  • Favicon and Social icons
  • FontAwesome Icon Support
  • SASS and AutoMinify Support
  • Google Analytics Support

Demo

https://caressofsteel.github.io/demos/hugo/hugo-story/

Using

1. Install Hugo

Install Hugo (Extended Version)

This theme uses Hugo Pipes to compile SCSS & Sass so you'll have to use the extended version of Hugo. See the official Hugo Quick Start Guide for more information.

2. Create a new site

hugo new site story-examplesite

3. Clone this Git repository

cd story-examplesite
git clone https://github.com/caressofsteel/hugo-story.git themes/hugo-story

Hint: See a note for non-Git users here.

4. Copy data and config.toml with overwrite from exampleSite

cp -r themes/hugo-story/exampleSite/data ./
cp themes/hugo-story/exampleSite/config.toml ./

Hint: Using config.toml tells Hugo to use the theme and sets some basic theme parameters.

Hint: Using data provides default content for the site.

5. Start Hugo Server

hugo server

6. Open Hugo Server in your browser

http://localhost:1313/

Here you'll see the site running on the local Hugo server. You can now make changes to and Hugo will rebuild the site automatically.

Hint: A copy of the default generated site is located in the originalStorySite folder should you need to reference it.

7. Further steps

  • Change the contents of YML files in the data folder.

    • Altering banner.yml will change the top block on the site. See more details here.

  • Create a custom site layout.

    • Copy the default index.html.

      cp themes/hugo-story/layouts/index.html layouts/

    • By manipulating the the {{ partial ... }} tags within this file you can create a custom layout for the site. See more details here.

  • Continue exploring Hugo and the template!

Credits

This theme was created using the Story template by HTML5 UP.

License

Creative Commons License

This Hugo theme is licensed under the Creative Commons Attribution 3.0 License.