mirror/gohugoio-hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-05-11 05:54:58 +00:00
Code Issues Releases Activity

Minor proofreading corrections to Hugo docs

Browse Source
This commit is contained in:
Anthony Fok
2014-08-31 05:08:36 -06:00
committed by spf13
parent f142458c4b
commit a6022293af
26 changed files with 130 additions and 129 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/content/overview/installing.md
View File

@@ -11,16 +11,16 @@ title: Installing Hugo
weight: 20
---
Hugo is written in Go with support for Windows, Linux, FreeBSD and OSX.
Hugo is written in Go with support for Windows, Linux, FreeBSD and OS X.
The latest release can be found at [hugo releases](https://github.com/spf13/hugo/releases).
We currently build for Windows, Linux, FreeBSD and OS X for x64
and 386 architectures.
The latest release can be found at [Hugo Releases](https://github.com/spf13/hugo/releases).
We currently build for Windows, Linux, FreeBSD and OS X for x64
and i386 architectures.
## Installing Hugo (binary)
Installation is very easy. Simply download the appropriate version for your
platform from [hugo releases](https://github.com/spf13/hugo/releases).
platform from [Hugo Releases](https://github.com/spf13/hugo/releases).
Once downloaded it can be run from anywhere. You don't need to install
it into a global location. This works well for shared hosts and other systems
where you don't have a privileged account.
@@ -28,16 +28,16 @@ where you don't have a privileged account.
Ideally you should install it somewhere in your path for easy use. `/usr/local/bin`
is the most probable location.
### Installing pygments (optional)
### Installing Pygments (optional)
The Hugo executable has one *optional* external dependency for source code highlighting (pygments).
The Hugo executable has one *optional* external dependency for source code highlighting (Pygments).
If you want to have source code highlighting using the [highlight shortcode](/extras/highlighting)
you need to install the python-based pygments program. The procedure is outlined on the [pygments home page](http://pygments.org).
If you want to have source code highlighting using the [highlight shortcode](/extras/highlighting),
you need to install the Python-based Pygments program. The procedure is outlined on the [Pygments home page](http://pygments.org).
## Upgrading Hugo
Upgrading hugo is as easy as downloading and replacing the executable you’ve
Upgrading Hugo is as easy as downloading and replacing the executable you’ve
placed in your path.
@@ -50,9 +50,9 @@ placed in your path.
* Mercurial
* Bazaar
### Get directly from Github:
### Get directly from GitHub:
go get github.com/spf13/hugo
go get -v github.com/spf13/hugo
### Building Hugo
@@ -62,4 +62,4 @@ placed in your path.
## Contributing
Please see the [contributing guide](/doc/contributing)
Please see the [contributing guide](/doc/contributing).

50
docs/content/overview/introduction.md
View File

@@ -11,36 +11,36 @@ weight: 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 & Drupal which run on your web server expensively building a page
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 then they are
edited, Hugo is optimized for website viewing while providing a great
writing experience.
writing experience.
Sites built with hugo are extremely fast and very secure. Hugo sites can
Sites built with Hugo are extremely fast and very secure. Hugo sites can
be hosted anywhere including Heroku, GoDaddy, GitHub pages, S3
& Cloudfront and work well with CDNs. Hugo sites run without dependencies
and Cloudfront and work well with CDNs. Hugo sites run without dependencies
on expensive run times like Ruby, Python or PHP and without dependencies
on any databases.
We think of Hugo as the ideal website creation tool. With nearly instant
built times and the ability to rebuild whenever a change is made Hugo
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.
designing websites, but also very useful when creating content.
## 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.
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 built times (~1ms per page)
* Completely cross platform: Runs on Mac OSX, Linux and Windows
* Extremely fast build times (~1 ms per page)
* Completely cross platform: Runs on Mac OS X, Linux and Windows
* Easy [installation](/overview/installing)
* Render changes [on the fly](/overview/usage) with [live reload](/extras/livereload) as you develop
* Complete theme support
@@ -50,13 +50,13 @@ Hugo boasts the following features:
* Straightforward [organization](/content/organization)
* Support for [website sections](/content/sections)
* Completely customizable [urls](/extras/urls)
* Completely customizable [URLs](/extras/urls)
* Support for configurable [taxonomies](/indexes/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
* [Pretty URLs](/extras/urls) support
* [Permalink](/extras/permalinks) pattern support
* [Aliases](/extras/aliases) (redirects)
### Content
@@ -66,7 +66,7 @@ Hugo boasts the following features:
* 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
* [shortcodes](/extras/shortcodes) to enable rich content inside of Markdown
* ["Minutes to Read"](/layout/variables) functionality
* ["Wordcount"](/layout/variables) functionality
@@ -74,7 +74,7 @@ Hugo boasts the following features:
* Integrated Disqus comment support
* Automatic [RSS](/layout/rss) creation
* Support for go and amber templates
* Support for Go and [Amber](https://github.com/eknkc/amber) templates
* Syntax [highlighting](/extras/highlighting) powered by pygments
See what's coming next in the [roadmap](/meta/roadmap)
@@ -86,29 +86,29 @@ a browser.
Hugo is for people who want to hand code their own website without
worrying about setting up complicated runtimes, dependencies and
databases.
databases.
Hugo is for people building a blog, company site, portfolio, tumblog,
documentation, single page site or a site with thousands of
pages.
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
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
simpler Markdown. Overall I felt like it got in my way more than it helped
my from writing great content.
I looked at existing static site generators like Jekyll, Middle and Nanoc.
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
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.
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
@@ -121,4 +121,4 @@ as I have writing it.
* [Install Hugo](/overview/installing)
* [Quick start](/overview/quickstart)
* [Join the Mailing List](/community/mailing-list)
* [Star us on Github](http://github.com/spf13/hugo)
* [Star us on GitHub](http://github.com/spf13/hugo)

26
docs/content/overview/quickstart.md
View File

@@ -16,12 +16,12 @@ proceeding._
## Step 1. Install Hugo
Goto [hugo releases](https://github.com/spf13/hugo/releases) and download the
Go to [Hugo Releases](https://github.com/spf13/hugo/releases) and download the
appropriate version for your os and architecture.
Save it somewhere specific as we will be using it in the next step.
More complete instructions are available at [installing hugo](/overview/installing/)
More complete instructions are available at [Installing Hugo](/overview/installing/)
## Step 2. Have Hugo Create a site for you
@@ -59,7 +59,7 @@ A new file is now created in `content/` with the following contents
Notice the date is automatically set to the moment you created the content.
Place some content in this file below the `+++` in the markdown format.
Place some content in this file below the `+++` in the Markdown format.
For example you could put this
@@ -67,7 +67,7 @@ For example you could put this
Some Content
For fun, let’s create another piece of content and place some markdown in it as well.
For fun, let’s create another piece of content and place some Markdown in it as well.
hugo new post/first.md
@@ -83,9 +83,9 @@ We still lack any templates to tell us how to display the content.
## Step 5. Run Hugo
Hugo contains it’s own high performance web server. Simply run `hugo
Hugo contains its own high performance web server. Simply run `hugo
server` and Hugo will find an available port and run a server with
your content
your content:
hugo server --theme=hyde --buildDrafts
2 pages created
@@ -96,16 +96,16 @@ your content
Web Server is available at http://localhost:1313
Press ctrl+c to stop
We specified two options here.
We specified two options here:
* `--theme` to pick which theme.
* `--buildDrafts` because we want to display our content, both set to draft status
* `--theme` to pick which theme;
* `--buildDrafts` because we want to display our content, both set to draft status.
To learn about what other options hugo has run
To learn about what other options hugo has, run:
hugo help
To learn about the server options
To learn about the server options:
hugo help server
@@ -132,7 +132,7 @@ Open your [favorite editor](http://vim.spf13.com), edit and save your content an
It’s especially productive to leave a browser open on a second monitor
and just glance at it whenever you save. You don’t even need to tab to
your browser. Hugo is so fast, that the new site will be there before
your browser. Hugo is so fast that the new site will be there before
you can look at the browser in most cases.
Change and save this file. Notice what happened in your terminal.
@@ -153,7 +153,7 @@ Things to try:
* Add a [new content file](/content/organization/)
* Create a [new section](/content/sections/)
* Modify [a template](/layout/templates/)
* Create content with [toml front matter](/content/front-matter/)
* Create content with [TOML front matter](/content/front-matter/)
* Define your own field in [front matter](/content/front-matter/)
* Display that [field in the template](/layout/variables/)
* Create a [new content type](/content/types/)

2
docs/content/overview/usage.md
View File

@@ -27,7 +27,7 @@ Make sure either hugo is in your path or provide a path to it.
hugo [command]
Available Commands:
server :: Hugo runs it's own a webserver to render the files
server :: Hugo runs its own a webserver to render the files
version :: Print the version number of Hugo
check :: Check content in the source directory
benchmark :: Benchmark hugo by building a site a number of times