Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blkdevcon/gohugo-deploy
https://github.com/blkdevcon/gohugo-deploy
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/blkdevcon/gohugo-deploy
- Owner: blkdevcon
- License: mit
- Created: 2022-03-19T19:16:07.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-03-19T19:16:59.000Z (over 2 years ago)
- Last Synced: 2024-08-02T13:24:33.193Z (4 months ago)
- Language: JavaScript
- Size: 12.3 MB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-starz - blkdevcon/gohugo-deploy - (JavaScript)
README
# 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]](mailto:[email protected]). If you want to share anything with the team about this template, you can also fill out [this form](https://template-feedback.netlify.app/).
As an alternative to this repository, we're recommending to take a look at [Hyas](https://github.com/h-enk/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](https://gohugo.io/) as a static site generator and [Webpack 5](https://webpack.js.org/) as your asset pipeline.
Victor Hugo setup to use [PostCSS v8](http://postcss.org/) and [Babel v7](https://babeljs.io/) for CSS and JavaScript compiling/transpiling.
This project is released under the [MIT license](LICENSE). Please make sure you understand its implications and guarantees.
## Usage
### :exclamation: Prerequisites
This template has been tested to work with [Node.js](https://nodejs.org/en/download/) v16 and [npm](https://www.npmjs.com/get-npm) v6.
Next step, clone this repository and run:
```bash
npm install
```
This will take some time and will install all packages necessary to run Victor Hugo and its tasks.
### :construction_worker: Development
While developing your website, use:
```bash
npm start
```
or for developing your website with `hugo server --buildDrafts --buildFuture`, use:
```bash
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.
### :package: Static build
To build a static version of the website inside the `/dist` folder, run:
```bash
npm run build
```
To get a preview of posts or articles not yet published, run:
```bash
npm run build:preview
```
See [package.json](package.json#L8) 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](http://cssnext.io/), 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
- Push your clone to your own GitHub repository.
- [Create a new site on Netlify](https://app.netlify.com/start) and link the repository.
Now Netlify will build and deploy your site whenever you push to git.
You can also click this button:
[](https://app.netlify.com/start/deploy?repository=https://github.com/netlify/victor-hugo)
## Enjoy!! 😸