github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-21 20:46:30 -05:00
Code Issues Projects Releases Packages Wiki Activity
hugo/docs/content/overview/introduction.md
mdhender 9a499b56c9 Add a section comparing the 'build' and 'server' 
One of the first things that new users have to understand is the
difference between Hugo as a web server and Hugo as a web site
generator. Issue #852 asked for documentation to make that clear.

This patch updates the overview page with that information. It will
seem repetitive to users that understand the difference. Weigh that
against the needs of those that don't.

Reference #852
2015-04-04 23:58:10 +02:00

7.8 KiB
Raw Blame History

date linktitle menu next title weight
2013-07-01 Introduction
main
parent
getting started
/overview/quickstart Introduction to Hugo 5

What is Hugo?

Hugo is a general-purpose website framework. Technically speaking, Hugo is a static site generator. This means that, unlike systems like WordPress, Ghost and Drupal, which run on your web server expensively building a page every time a visitor requests one, Hugo does the building when you create your content. Since websites are viewed far more often than they are edited, Hugo is optimized for website viewing while providing a great writing experience.

Sites built with Hugo are extremely fast and very secure. Hugo sites can be hosted anywhere, including Heroku, GoDaddy, DreamHost, GitHub Pages, Amazon S3 and CloudFront, and work well with CDNs. Hugo sites run without dependencies on expensive runtimes like Ruby, Python or PHP and without dependencies on any databases.

We think of Hugo as the ideal website creation tool. With nearly instant build times and the ability to rebuild whenever a change is made, Hugo provides a very fast feedback loop. This is essential when you are designing websites, but also very useful when creating content.

What makes Hugo different?

Web site generators render content into HTML files. Most are "dynamic site generators." That means the HTTP server (which is the program running on your website that the user's browser talks to) runs the generator to create a new HTML file each and every time a user wants to view a page.

Creating the page dynamically means that the computer hosting the HTTP server has to have enough memory and CPU to effectively run the generator around the clock. If not, then the user has to wait in a queue for the page to be generated.

Nobody wants users to wait longer than needed, so the dynamic site generators programmed their systems to cache the HTML files. When a file is cached, a copy of it is temporarily stored on the computer. It is much faster for the HTTP server to send that copy the next time the page is requested than it is to generate it from scratch.

Hugo takes cacheing a step further. All HTML files are rendered on your computer. You can review the files before you copy them to the computer hosting the HTTP server. Since the HTML files aren't generated dynamically, we say that Hugo is a "static site generator."

Not running a web site generator on your HTTP server has many benefits. The most noticeable is performance - HTTP servers are very good at sending files. So good that you can effectively serve the same number of pages with a fraction of the memory and CPU needed for a dynamic site.

Hugo has two components to help you build and test your web site. The one that you'll probably use most often is the built-in HTTP server. When you run hugo server, Hugo renders all of your content into HTML files and then runs a HTTP server on your computer so that you can see what the pages look like.

The second component is used when you're ready to publish your web site to the computer running your website. Running Hugo without any actions will rebuild your entire web site using the baseurl setting from your site's configuration file. That's required to have your page links work properly with most hosting companies.

How fast is Hugo?

{{% youtube CdiDYZ51a2o %}}

What does Hugo do?

In technical terms, Hugo takes a source directory of Markdown files and templates and uses these as input to create a complete website.

Hugo boasts the following features:

General

  • Extremely fast build times (~1 ms per page)
  • Completely cross platform: Runs on  Mac OS X,  Linux,  Windows, and more!
  • Easy installation
  • Render changes on the fly with LiveReload as you develop
  • Complete theme support
  • Host your site anywhere

Organization

Content

Additional Features

See what's coming next in the roadmap.

Who should use Hugo?

Hugo is for people that prefer writing in a text editor over a browser.

Hugo is for people who want to hand code their own website without worrying about setting up complicated runtimes, dependencies and databases.

Hugo is for people building a blog, company site, portfolio, tumblog, documentation, single page site or a site with thousands of pages.

Why did you write Hugo?

I wrote Hugo ultimately for a few reasons. First, I was disappointed with WordPress, my then website solution. It rendered slowly. I couldn't create content as efficiently as I wanted to and needed to be online to write posts. The constant security updates and the horror stories of people's hacked blogs. I hated how content was written in HTML instead of the much simpler Markdown. Overall, I felt like it got in my way more than it helped me from writing great content.

I looked at existing static site generators like Jekyll, Middleman and nanoc. All had complicated dependencies to install and took far longer to render my blog with hundreds of posts than I felt was acceptable. I wanted a framework to be able to get rapid feedback while making changes to the templates, and the 5+-minute render times was just too slow. In general, they were also very blog minded and didn't have the ability to have different content types and flexible URLs.

I wanted to develop a fast and full-featured website framework without dependencies. The Go language seemed to have all of the features I needed in a language. I began developing Hugo in Go and fell in love with the language. I hope you will enjoy using (and contributing to) Hugo as much as I have writing it.

Next Steps