hugo/docs/content/overview/introduction.md

190 lines
8.1 KiB
Markdown
Raw Normal View History

2014-02-20 19:03:37 -05:00
---
2016-02-20 02:16:14 -05:00
lastmod: 2016-02-20
2014-05-29 18:42:05 -04:00
date: 2013-07-01
linktitle: Introduction
menu:
main:
2014-05-29 18:42:05 -04:00
parent: getting started
next: /overview/quickstart
title: Introduction to Hugo
weight: 5
2014-02-20 19:03:37 -05:00
---
## What is Hugo?
Hugo is a general-purpose website framework. Technically speaking, Hugo is
a static site generator. Unlike other systems which dynamically build a page
2014-02-20 19:03:37 -05:00
every time a visitor requests one, Hugo does the building when you create
2015-02-16 16:53:12 -05:00
your content. Since websites are viewed far more often than they are
2014-02-28 11:41:47 -05:00
edited, Hugo is optimized for website viewing while providing a great
writing experience.
2014-02-20 19:03:37 -05:00
Sites built with Hugo are extremely fast and very secure. Hugo sites can
be hosted anywhere, including [Heroku][], [GoDaddy][], [DreamHost][],
[GitHub Pages][], [Surge][], [Aerobatic][], [Google Cloud Storage][],
[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.
[Heroku]: https://www.heroku.com/
[GoDaddy]: https://www.godaddy.com/
[DreamHost]: http://www.dreamhost.com/
2015-01-25 16:53:21 -05:00
[GitHub Pages]: https://pages.github.com/
[Aerobatic]: https://www.aerobatic.com/
2015-04-07 23:02:20 -04:00
[Google Cloud Storage]: http://cloud.google.com/storage/
[Amazon S3]: http://aws.amazon.com/s3/
[CloudFront]: http://aws.amazon.com/cloudfront/ "Amazon CloudFront"
[Surge]: https://surge.sh
2014-02-20 19:03:37 -05:00
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
2014-02-20 19:03:37 -05:00
provides a very fast feedback loop. This is essential when you are
designing websites, but also very useful when creating content.
2014-02-20 19:03:37 -05:00
## 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.
2015-05-29 11:14:37 -04:00
Hugo takes caching 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
2016-02-20 02:16:14 -05:00
HTML files and then runs an 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 %}}
2014-02-20 19:03:37 -05:00
## What does Hugo do?
In technical terms, Hugo takes a source directory of files and
templates and uses these as input to create a complete website.
2014-02-20 19:03:37 -05:00
Hugo boasts the following features:
### General
2016-02-20 02:16:14 -05:00
* Extremely fast build times (~1 ms per page)
* Completely cross platform: Runs on <i class="fa fa-apple"></i>&nbsp;Mac OS&nbsp;X, <i class="fa fa-linux"></i>&nbsp;Linux, <i class="fa fa-windows"></i>&nbsp;Windows, and more!
* Easy [installation](/overview/installing/)
* Render changes [on the fly](/overview/usage/) with [LiveReload](/extras/livereload/) as you develop
* Complete theme support
2014-02-20 19:03:37 -05:00
* Host your site anywhere
### Organization
* Straightforward [organization](/content/organization/)
* Support for [website sections](/content/sections/)
* Completely customizable [URLs](/extras/urls/)
* Support for configurable [taxonomies](/taxonomies/overview/) which includes categories and tags. Create your own custom organization of content
* Ability to [sort content](/content/ordering/) as you desire
* Automatic [table of contents](/extras/toc/) generation
* Dynamic menu creation
* [Pretty URLs](/extras/urls/) support
* [Permalink](/extras/permalinks/) pattern support
* [Aliases](/extras/aliases/) (redirects)
### Content
* Native support for content written in [Markdown](/content/example/)
* Support for other languages through _external helpers_, see [supported formats](/content/supported-formats)
* Support for TOML, YAML and JSON metadata in [frontmatter](/content/front-matter/)
* Completely [customizable homepage](/layout/homepage/)
* Support for multiple [content types](/content/types/)
* Automatic and user defined [summaries](/content/summaries/)
* [Shortcodes](/extras/shortcodes/) to enable rich content inside of Markdown
* ["Minutes to Read"](/layout/variables/) functionality
* ["Wordcount"](/layout/variables/) functionality
2014-02-20 19:03:37 -05:00
### Additional Features
* Integrated [Disqus](https://disqus.com/) comment support
* Integrated [Google Analytics](https://google-analytics.com/) support
* Automatic [RSS](/layout/rss/) creation
* Support for [Go](http://golang.org/pkg/html/template/), [Amber](https://github.com/eknkc/amber) and [Ace](http://ace.yoss.si/) HTML templates
* Syntax [highlighting](/extras/highlighting/) powered by [Pygments](http://pygments.org/)
See what's coming next in the [roadmap](/meta/roadmap/).
2014-02-20 19:05:09 -05:00
2014-02-20 19:03:37 -05:00
## Who should use Hugo?
Hugo is for people that prefer writing in a text editor over
a browser.
2014-02-20 19:03:37 -05:00
Hugo is for people who want to hand code their own website without
worrying about setting up complicated runtimes, dependencies and
databases.
2014-02-20 19:03:37 -05:00
Hugo is for people building a blog, company site, portfolio, tumblog,
documentation, single page site or a site with thousands of
pages.
2014-02-20 19:03:37 -05:00
## 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
2014-02-20 19:03:37 -05:00
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
2014-02-20 19:05:09 -05:00
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.
2014-02-20 19:03:37 -05:00
I looked at existing static site generators like [Jekyll][], [Middleman][] and [nanoc][].
2014-02-20 19:03:37 -05:00
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,
2014-02-20 19:03:37 -05:00
they were also very blog minded and didn't have the ability to have
different content types and flexible URLs.
2014-02-20 19:03:37 -05:00
[Jekyll]: http://jekyllrb.com/
[Middleman]: https://middlemanapp.com/
[nanoc]: http://nanoc.ws/
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
2014-02-20 19:03:37 -05:00
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.
2014-02-20 19:05:09 -05:00
[Go language]: http://golang.org/ "The Go Programming Language"
2014-02-20 19:05:09 -05:00
## Next Steps
* [Install Hugo](/overview/installing/)
* [Quick start](/overview/quickstart/)
* [Join the Mailing List](/community/mailing-list/)
* [Star us on GitHub](https://github.com/spf13/hugo)
* [Discussion Forum](http://discuss.gohugo.io/)