Giter Club home page Giter Club logo

hugo-start's Introduction

Hugo Start

A simple hugo boilerplate showing some of Hugo's functionality.

Quick Start

  • Download latest release and unzip into your working directory.
  • Rename the folder as you want.
  • Navigate to this folder in your command line (PowerShell in Windows, Terminal in macOS or Linux).
  • Run hugo server.
  • Hugo should return several messages (see code below). There is an address that allows opening the website in your browser: below it's http://localhost:1313/hugo-start/.
$ hugo server

                   | EN  
+------------------+----+
  Pages            | 21  
  Paginator pages  |  0  
  Non-page files   |  0  
  Static files     |  2  
  Processed images |  0  
  Aliases          |  0  
  Sitemaps         |  1  
  Cleaned          |  0  

Total in 30 ms
Watching for changes in /Users/<username>/Projects/start/{content,data,layouts,static}
Serving pages from memory
Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender
Web Server is available at http://localhost:1313/hugo-start/ (bind address 127.0.0.1)
Press Ctrl+C to stop

Best Practice

When adding small changes, do not commit anything from /docs folder. Push changes in docs only after some milestone, preferably by a single user, so that merge conflicts do not make work with the repository difficult.

Generally, built files are not to be commited exactly for this reason โ€” but in this case, they're useful to generate a Github Sites based website.

Troubleshooting

  • When running hugo new, this error is shown: Unable to locate Config file. Perhaps you need to create a new site. You're in a wrong folder.
  • When running any comman, this error is shown: command not found: hugo. Hugo is not installed correctly. Either reinstall Hugo or check whether you typed it correctly.

hugo-start's People

Contributors

447937 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.