Git/hugo-story
1
0
Fork 1
mirror of https://github.com/caressofsteel/hugo-story.git synced 2024-12-22 01:25:07 +01:00
Code Issues Packages Projects Releases Wiki Activity
A (modular, highly tweakable) responsive one-page theme for Hugo.
18 Commits 1 Branch 0 Tags 37 MiB
HTML 81.5%
SCSS 14.3%
JavaScript 4.2%
96d1bbc2e5
Go to file
⚔️ DR ⚔️ 96d1bbc2e5
Merge pull request #10 from applikationsprogramvara/add_quick_start_to_readme 
Adding steps into quick start guide
2021-02-05 13:47:03 -05:00
assets First Commit - Hugo Story 2020-07-02 01:05:45 -04: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 fixing footer - moving li into with 2021-02-01 19:07:20 +01: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 cosmetic fixes of README 2021-02-05 01:47:29 +01: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

    This theme uses Hugo Pipes to compile SCSS & Sass so you'll have to use the extended version of Hugo.
    Install Hugo (Extended Version)

    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 submodule add 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 themes/exampleSite to the main directory:

    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 some default contents for the site.

  5. Start Hugo server:

    hugo server

  6. Open Hugo site in your browser http://localhost:1313/

    Now you should see the orginal Story site. You can also take a look into it in folder originalStorySite.

  7. Further steps

    • Change the contents of folder data. E.g. by altering banner.yml you can change the top block on the site. See more details here.

    • Copy default index.html:

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

      Now you can create your own structure of the site by manipulating {{ partial ... }} tags. 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.