github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-12-27 07:14:25 +00:00
Code Issues Projects Releases Packages Wiki Activity
hugo/docs/content/overview/installing.md

86 lines
3.1 KiB
Markdown
Raw Normal View History

sanity: move from json to yaml
2013-07-06 23:36:30 +00:00
---
Converting front matter to YAML
2014-05-29 22:42:05 +00:00
aliases:
- /doc/installing/
docs: Add lastmod to content files Based on last commit in Git.
2016-01-06 22:45:19 +00:00
lastmod: 2016-01-04
Converting front matter to YAML
2014-05-29 22:42:05 +00:00
date: 2013-07-01
Implementing new menu system in the docs site
2014-04-23 07:00:11 +00:00
menu:
main:
Converting front matter to YAML
2014-05-29 22:42:05 +00:00
parent: getting started
next: /overview/usage
prev: /overview/quickstart
title: Installing Hugo
weight: 20
YAML support similar to jekyll (start and end with '---')
2013-07-08 21:57:01 +00:00
---
sanity: move from json to yaml
2013-07-06 23:36:30 +00:00
Update README.md and overview/installing.md - Clarify that Hugo may be built wherever Go is available; - Add links to Git, Mercurial and Go; - Unlist Bazaar: No libraries that Hugo depends on use it any more; - Suggest the user to simply run `make` to build `hugo` to get `hugo version` to display the commit hash.
2015-02-21 20:42:15 +00:00
Hugo is written in [Go][] with support for multiple platforms.
adding hugo
2013-07-04 15:32:55 +00:00
Minor proofreading corrections to Hugo docs
2014-08-31 11:08:36 +00:00
The latest release can be found at [Hugo Releases](https://github.com/spf13/hugo/releases).
Update README.md and overview/installing.md - Clarify that Hugo may be built wherever Go is available; - Add links to Git, Mercurial and Go; - Unlist Bazaar: No libraries that Hugo depends on use it any more; - Suggest the user to simply run `make` to build `hugo` to get `hugo version` to display the commit hash.
2015-02-21 20:42:15 +00:00
We currently provide pre-built binaries for
<i class="fa fa-windows"></i>&nbsp;Windows,
[Docs] Add FreeBSD logo beside the FreeBSD name Extracted from https://www.freebsd.org/logo/logo-simple.svg for temporary use until a future Font Awesome release adds the `fa-freebsd` glyph (github/FortAwesome/Font-Awesome#1116) :-) Make .fa `display: inline` to prevent unwanted line-wrapping Also make the menu item "Issue & Help" line up with the others.
2015-01-19 08:49:12 +00:00
<i class="fa fa-linux"></i>&nbsp;Linux,
<i class="fa freebsd-19px"></i>&nbsp;FreeBSD
[Docs] NetBSD and ARM pre-built binaries are already provided See https://github.com/spf13/hugo/releases What a pleasant surprise indeed! How come I have never noticed them before? And even `.deb` files are provided! How amazing!
2015-02-22 06:26:34 +00:00
and <i class="fa fa-apple"></i>&nbsp;OS&nbsp;X (Darwin)
for x64, i386 and ARM architectures.
adding hugo
2013-07-04 15:32:55 +00:00
[Docs] NetBSD and ARM pre-built binaries are already provided See https://github.com/spf13/hugo/releases What a pleasant surprise indeed! How come I have never noticed them before? And even `.deb` files are provided! How amazing!
2015-02-22 06:26:34 +00:00
Hugo may also be compiled from source wherever the Go compiler tool chain can run, e.g. for other operating systems including DragonFly BSD, OpenBSD, Plan&nbsp;9 and Solaris. See http://golang.org/doc/install/source for the full set of supported combinations of target operating systems and compilation architectures.
Update README.md and overview/installing.md - Clarify that Hugo may be built wherever Go is available; - Add links to Git, Mercurial and Go; - Unlist Bazaar: No libraries that Hugo depends on use it any more; - Suggest the user to simply run `make` to build `hugo` to get `hugo version` to display the commit hash.
2015-02-21 20:42:15 +00:00
Improving installation instructions
2013-07-24 15:43:23 +00:00
## Installing Hugo (binary)
better install instructions and fixing usage typo
2013-07-05 04:35:11 +00:00
Installation is very easy. Simply download the appropriate version for your
Minor proofreading corrections to Hugo docs
2014-08-31 11:08:36 +00:00
platform from [Hugo Releases](https://github.com/spf13/hugo/releases).
Improving installation instructions
2013-07-24 15:43:23 +00:00
Once downloaded it can be run from anywhere. You don't need to install
better install instructions and fixing usage typo
2013-07-05 04:35:11 +00:00
it into a global location. This works well for shared hosts and other systems
where you don't have a privileged account.
adding hugo
2013-07-04 15:32:55 +00:00
Some more random copyediting of Hugo docs - Change "livereload" and "live reload" to "LiveReload"; - Add a `$ ` prompt before example command lines (not exhaustive, work in progress); - Remove unnecessary whitespace from partials; - Revise the blackfriday options table in overview/configuration.md to make it narrower. - Manually set the language for highlight.js where appropriate - Rename "404" to "Custom 404 page", and remove incorrect reference to "homepage" - Credit the author of tutorials/github_pages_blog.md (Similar notes are necessary for other contributed pages where "I" am not spf13 to avoid reader confusion.) - Add CSS for `kbd` and `table` etc. to css/style.css; - etc.
2015-01-09 18:51:15 +00:00
Ideally, you should install it somewhere in your `PATH` for easy use.
`/usr/local/bin` is the most probable location.
adding hugo
2013-07-04 15:32:55 +00:00
[Docs] Copyediting * Add meta author, description and generator tags * Add Hugo version beside the logo and in the footer * Suggest the user to run `go get -u -v` to update dependencies * Requires Go 1.3+ rather than Go 1.1+ * Improve rendering/formatting in some places * Add trailing slash to URLs where appropriate * GitHub redirects all http requests to https, update accordingly
2015-01-28 02:17:09 +00:00
On OS&nbsp;X, if you have [Homebrew](http://brew.sh/), installation is even
Docs: Run "brew update" before "brew install hugo" Remind user to always run "brew update" first in order to avoid repeated bug reports from users who didn't do that. See #824, #1067, #1537, #1633 and #1749
2016-01-05 06:36:57 +00:00
easier: just run `brew update && brew install hugo`.
instructions for Homebrew installation updated installation page of documentation, and changed "Download" button on index.html to scroll to bottom where multiple installation options are featured getting the scrolldown to work required removing the fixed positioning on #action and on the footer
2014-09-22 23:58:30 +00:00
Docs: add cross-references to installation guides
2015-12-24 21:52:52 +00:00
For a more detailed explanation follow the corresponding installation guides:
- [Installation on OS X]({{< relref "tutorials/installing-on-mac.md" >}})
- [Installation on Windows]({{< relref "tutorials/installing-on-windows.md" >}})
Minor proofreading corrections to Hugo docs
2014-08-31 11:08:36 +00:00
### Installing Pygments (optional)
Misc doc fixes * Pygments links and requirements for installation. * Fix to link to additional template functions in release notes for v0.10
2014-04-08 15:15:56 +00:00
Minor proofreading corrections to Hugo docs
2014-08-31 11:08:36 +00:00
The Hugo executable has one *optional* external dependency for source code highlighting (Pygments).
Misc doc fixes * Pygments links and requirements for installation. * Fix to link to additional template functions in release notes for v0.10
2014-04-08 15:15:56 +00:00
[Docs] Copyediting * Add meta author, description and generator tags * Add Hugo version beside the logo and in the footer * Suggest the user to run `go get -u -v` to update dependencies * Requires Go 1.3+ rather than Go 1.1+ * Improve rendering/formatting in some places * Add trailing slash to URLs where appropriate * GitHub redirects all http requests to https, update accordingly
2015-01-28 02:17:09 +00:00
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/).
adding better install directions
2013-07-04 17:03:16 +00:00
Updating / Rewriting / Adding all of the documentation in preparation for the next release
2014-05-27 22:32:57 +00:00
## Upgrading Hugo
Minor proofreading corrections to Hugo docs
2014-08-31 11:08:36 +00:00
Upgrading Hugo is as easy as downloading and replacing the executable you’ve
Some more random copyediting of Hugo docs - Change "livereload" and "live reload" to "LiveReload"; - Add a `$ ` prompt before example command lines (not exhaustive, work in progress); - Remove unnecessary whitespace from partials; - Revise the blackfriday options table in overview/configuration.md to make it narrower. - Manually set the language for highlight.js where appropriate - Rename "404" to "Custom 404 page", and remove incorrect reference to "homepage" - Credit the author of tutorials/github_pages_blog.md (Similar notes are necessary for other contributed pages where "I" am not spf13 to avoid reader confusion.) - Add CSS for `kbd` and `table` etc. to css/style.css; - etc.
2015-01-09 18:51:15 +00:00
placed in your `PATH`.
Updating / Rewriting / Adding all of the documentation in preparation for the next release
2014-05-27 22:32:57 +00:00
adding better install directions
2013-07-04 17:03:16 +00:00
## Installing from source
Update README.md and overview/installing.md - Clarify that Hugo may be built wherever Go is available; - Add links to Git, Mercurial and Go; - Unlist Bazaar: No libraries that Hugo depends on use it any more; - Suggest the user to simply run `make` to build `hugo` to get `hugo version` to display the commit hash.
2015-02-21 20:42:15 +00:00
### Prerequisite tools for downloading and building source code
Adding better source build instructions
2013-07-19 05:27:21 +00:00
Update README.md and overview/installing.md - Clarify that Hugo may be built wherever Go is available; - Add links to Git, Mercurial and Go; - Unlist Bazaar: No libraries that Hugo depends on use it any more; - Suggest the user to simply run `make` to build `hugo` to get `hugo version` to display the commit hash.
2015-02-21 20:42:15 +00:00
* [Git](http://git-scm.com/)
* [Mercurial](http://mercurial.selenic.com/)
* [Go][] 1.3+ (Go 1.4+ on Windows, see Go [Issue #8090](https://code.google.com/p/go/issues/detail?id=8090))
adding better install directions
2013-07-04 17:03:16 +00:00
[Docs] More random revision and copyediting General revisions to (hopefully) make the documentation easier to understand and more comprehensive. Revise "Strange EOF error" troubleshooting page to say that a fix is in place for the upcoming Hugo v0.13. Also add more external links, and cute icons from Font Awesome.
2015-01-14 03:48:44 +00:00
### Get directly from GitHub
Improving installation instructions
2013-07-24 15:43:23 +00:00
[Docs] More random revision and copyediting General revisions to (hopefully) make the documentation easier to understand and more comprehensive. Revise "Strange EOF error" troubleshooting page to say that a fix is in place for the upcoming Hugo v0.13. Also add more external links, and cute icons from Font Awesome.
2015-01-14 03:48:44 +00:00
$ export GOPATH=$HOME/go
Some more random copyediting of Hugo docs - Change "livereload" and "live reload" to "LiveReload"; - Add a `$ ` prompt before example command lines (not exhaustive, work in progress); - Remove unnecessary whitespace from partials; - Revise the blackfriday options table in overview/configuration.md to make it narrower. - Manually set the language for highlight.js where appropriate - Rename "404" to "Custom 404 page", and remove incorrect reference to "homepage" - Credit the author of tutorials/github_pages_blog.md (Similar notes are necessary for other contributed pages where "I" am not spf13 to avoid reader confusion.) - Add CSS for `kbd` and `table` etc. to css/style.css; - etc.
2015-01-09 18:51:15 +00:00
$ go get -v github.com/spf13/hugo
adding better install directions
2013-07-04 17:03:16 +00:00
[Docs] More random revision and copyediting General revisions to (hopefully) make the documentation easier to understand and more comprehensive. Revise "Strange EOF error" troubleshooting page to say that a fix is in place for the upcoming Hugo v0.13. Also add more external links, and cute icons from Font Awesome.
2015-01-14 03:48:44 +00:00
`go get` will then fetch Hugo and all its dependent libraries to your
`$GOPATH/src` directory, and compile everything into the final `hugo`
(or `hugo.exe`) executable, which you will find sitting in the
[Docs] Copyediting * Add meta author, description and generator tags * Add Hugo version beside the logo and in the footer * Suggest the user to run `go get -u -v` to update dependencies * Requires Go 1.3+ rather than Go 1.1+ * Improve rendering/formatting in some places * Add trailing slash to URLs where appropriate * GitHub redirects all http requests to https, update accordingly
2015-01-28 02:17:09 +00:00
`$GOPATH/bin/` directory, all ready to go!
You may run `go get` with the `-u` option to update Hugo's dependencies:
$ go get -u -v github.com/spf13/hugo
Improving installation instructions
2013-07-24 15:43:23 +00:00
## Contributing
[Docs] Copyediting * Add meta author, description and generator tags * Add Hugo version beside the logo and in the footer * Suggest the user to run `go get -u -v` to update dependencies * Requires Go 1.3+ rather than Go 1.1+ * Improve rendering/formatting in some places * Add trailing slash to URLs where appropriate * GitHub redirects all http requests to https, update accordingly
2015-01-28 02:17:09 +00:00
Please see the [contributing guide](/doc/contributing/).
Update README.md and overview/installing.md - Clarify that Hugo may be built wherever Go is available; - Add links to Git, Mercurial and Go; - Unlist Bazaar: No libraries that Hugo depends on use it any more; - Suggest the user to simply run `make` to build `hugo` to get `hugo version` to display the commit hash.
2015-02-21 20:42:15 +00:00
[Go]: http://golang.org/
Reference in a new issue Copy permalink