• This repository has been archived on 24/Dec/2021
  • Stars
    star
    1,532
  • Rank 30,541 (Top 0.7 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created over 8 years ago
  • Updated almost 3 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Victor Hugo is a Hugo boilerplate for creating truly epic websites!

Victor Hugo

⚠️ Deprecation Notice 🏳

We are focusing our resources on building new templates that help you build a better web, because of that we're deprecating this template. We care about the community so we propose if anyone wants to maintain or take stewardship over the project please contact us at [email protected]. If you want to share anything with the team about this template, you can also fill out this form.

As an alternative to this repository, we're recommending to take a look at Hyas as a project to make use of. It is focused on latest practices with Hugo and is already completely Netlify deploy ready.


A Hugo boilerplate for creating truly epic websites

This is a boilerplate for using Hugo as a static site generator and Webpack 5 as your asset pipeline.

Victor Hugo setup to use PostCSS v8 and Babel v7 for CSS and JavaScript compiling/transpiling.

This project is released under the MIT license. Please make sure you understand its implications and guarantees.

Usage

Prerequisites

This template has been tested to work with Node.js v16 and npm v6.

Next step, clone this repository and run:

npm install

This will take some time and will install all packages necessary to run Victor Hugo and its tasks.

👷 Development

While developing your website, use:

npm start

or for developing your website with hugo server --buildDrafts --buildFuture, use:

npm run preview

Then visit http://localhost:3000/ - or a new browser windows popped-up already - to preview your new website. Webpack Dev Server will automatically reload the CSS or refresh the whole page, when stylesheets or content changes.

📦 Static build

To build a static version of the website inside the /dist folder, run:

npm run build

To get a preview of posts or articles not yet published, run:

npm run build:preview

See package.json for all tasks.

Structure

|--site                // Everything in here will be built with hugo
|  |--content          // Pages and collections - ask if you need extra pages
|  |--data             // YAML data files with any data for use in examples
|  |--layouts          // This is where all templates go
|  |  |--partials      // This is where includes live
|  |  |--index.html    // The index page
|  |--resources        // This is where all assets go
|  |--static           // Files in here ends up in the public folder
|--src                 // Files that will pass through the asset pipeline
|  |--css              // Webpack will bundle imported css separately
|  |--index.js         // index.js is the webpack entry for your css & js assets

Basic Concepts

You can read more about Hugo's template language in their documentation here:

https://gohugo.io/templates/overview/

The most useful page there is the one about the available functions:

https://gohugo.io/templates/functions/

For assets that are completely static and don't need to go through the asset pipeline, use the site/static folder. Images, font-files, etc, all go there.

Files in the static folder end up in the web root. So a file called site/static/favicon.ico will end up being available as /favicon.ico and so on...

The src/index.js file is the entrypoint for webpack and will be built to /dist/main.js

You can use ES6 and use both relative imports or import libraries from npm.

Any CSS file imported into the index.js will be run through Webpack, compiled with PostCSS Next, and minified to /dist/[name].[hash:5].css. Import statements will be resolved as part of the build.

Environment variables

To separate the development and production - aka build - stages, all tasks run with a node environment variable named either development or production.

You can access the environment variable inside the theme files with getenv "NODE_ENV". See the following example for a conditional statement:

{{ if eq (getenv "NODE_ENV") "development" }}You're in development!{{ end }}

All tasks starting with build set the environment variable to production - the other will set it to development.

Deploying to Netlify

Now Netlify will build and deploy your site whenever you push to git.

You can also click this button:

Deploy to Netlify

Enjoy!! 😸

More Repositories

1

gatsby-starter-netlify-cms

Example gatsby + netlify cms project
JavaScript
2,030
star
2

one-click-hugo-cms

Hugo template with Netlify CMS
SCSS
424
star
3

nextjs-blog-theme

A customizable Next.js and Tailwind blog starter. Designed by the Bejamas agency.
JavaScript
404
star
4

kpop-stack

Create a Remix app with Netlify, Tailwind, TypeScript and more!
TypeScript
231
star
5

jekyll-netlify-cms

A starter template for Jekyll and netlify CMS
HTML
138
star
6

next-netlify-starter

A one-click starter project for Next and Netlify
JavaScript
103
star
7

kaldi-hugo-cms-template

**Deprecated. Check out one-click-hugo-cms instead.**
CSS
93
star
8

gatsby-ecommerce-theme

A Gatsby-based starter theme with e-commerce styled components
JavaScript
90
star
9

astro-toolbox

Netlify ❤️ Astro: a simple template to give you the code you need to use Netlify features with Astro.
Astro
66
star
10

astro-quickstart

A bare-bones Astro template to get you deployed to Netlify fast!
Astro
38
star
11

nextjs-toolbox

Netlify ❤️ Next.js: A sample to give you the code you need to use Netlify features with Next.js.
JavaScript
34
star
12

hexo-cms-example

An example hexo/netlify CMS integration
CSS
29
star
13

next-platform-starter

Modern starter based on Next.js 14 (App Router), Tailwind, daisyUI, and Netlify Core Primitives
JavaScript
29
star
14

nuxt-toolbox

Netlify ❤️ Nuxt.js: a simple template to give you the code you need to use Netlify features with Nuxt.
JavaScript
25
star
15

astro-platform-starter

A modern starter based on Astro.js, Tailwind, daisyUI, and Netlify Core Primitives (Edge Functions, Image CDN, Blob Store).
Astro
22
star
16

next-starter-jamstack

A Next.js starter for the JAMstack
JavaScript
21
star
17

hugo-quickstart

A bare-bones Hugo template to get you deployed to Netlify fast!
HTML
20
star
18

angular-quickstart

A bare-bones Angular template to get you deployed to Netlify fast!
TypeScript
19
star
19

astro-sanity-starter

Netlify Astro and Sanity starter with visual editing.
TypeScript
17
star
20

roots-cms-example

An example roots/netlify CMS integration
CSS
13
star
21

solid-quickstart

A Solid Quickstart template that will get you started with everything you need to build a Solid project
TypeScript
10
star
22

jekyll-base

Fresh Jekyll install from running "jekyll new ..."
SCSS
3
star
23

mkdocs-base

Fresh Cactus install from "mkdocs new ..."
3
star
24

roots-base

Fresh Roots install from "roots new ..."
Stylus
1
star
25

hexo-base

Fresh Hexo install from "hexo init ..."
Stylus
1
star
26

hugo-base

Fresh Hugo Install from "hugo new site ..."
HTML
1
star