github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-30 05:33:16 -05:00
Code Issues Projects Releases Packages Wiki Activity
hugo/README.md

107 lines
5.6 KiB
Markdown
Raw Normal View History

Using a smaller Header Image
2015-03-04 09:16:49 -05:00
![Hugo](https://raw.githubusercontent.com/spf13/hugo/master/docs/static/img/hugo-logo.png)
Restructure top of Readme.md
2015-03-04 09:15:03 -05:00
Tidying the Readme a bit more
2015-03-04 09:17:35 -05:00
A Fast and Flexible Static Site Generator built with love by [spf13](http://spf13.com/) and [friends](https://github.com/spf13/hugo/graphs/contributors) in [Go][].
docs: Use HTTPS links in README where appropriate
2016-03-02 13:54:56 -05:00
[Website](https://gohugo.io) |
[Forum](https://discuss.gohugo.io) |
Readme: Clarify usage of Gitter
2016-09-28 08:51:40 -04:00
[Developer Chat (no support)](https://gitter.im/spf13/hugo) |
docs: Use HTTPS links in README where appropriate
2016-03-02 13:54:56 -05:00
[Documentation](https://gohugo.io/overview/introduction/) |
[Installation Guide](https://gohugo.io/overview/installing/) |
hugo: Update contribution guidelines Refactor the contribution guidelines in the README and CONTRIBUTING files. Simplify the contribution guide in the README and move most of the complex stuff into CONTRIBUTING. Add an explicit commit message guidelines section to CONTRIBUTING. Keep all of the guidelines from Chris Beams except for the 72 character line limit (we don't follow that, nor does the Go team). Add three new guidelines: package prefix in subject, references in body, and encouragement of message body in general. Add a new section to CONTRIBUTING on using Git Remotes.
2016-03-12 18:35:06 -05:00
[Contribution Guide](CONTRIBUTING.md) |
Restructure top of Readme.md
2015-03-04 09:15:03 -05:00
[Twitter](http://twitter.com/spf13)
Add GoDocs badge
2016-04-09 18:14:16 -04:00
[![GoDoc](https://godoc.org/github.com/spf13/hugo?status.svg)](https://godoc.org/github.com/spf13/hugo)
Improve build labels in README
2016-04-15 07:02:03 -04:00
[![Linux and OS X Build Status](https://api.travis-ci.org/spf13/hugo.svg?branch=master&label=Linux+and+OS+X+build "Linux and OS X Build Status")](https://travis-ci.org/spf13/hugo)
[![Windows Build Status](https://ci.appveyor.com/api/projects/status/n2mo912b8s2505e8/branch/master?svg=true&label=Windows+build "Windows Build Status")](https://ci.appveyor.com/project/spf13/hugo/branch/master)
Readme: Clarify usage of Gitter
2016-09-28 08:51:40 -04:00
[![Dev chat at https://gitter.im/spf13/hugo](https://img.shields.io/badge/gitter-developer_chat-46bc99.svg)](https://gitter.im/spf13/hugo?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Add Go Report Card badge to README
2016-03-17 18:24:24 -04:00
[![Go Report Card](https://goreportcard.com/badge/github.com/spf13/hugo)](https://goreportcard.com/report/github.com/spf13/hugo)
Added Gitter badge
2015-03-04 09:06:38 -05:00
updating readme
2013-07-04 11:34:22 -04:00
## Overview
Small Doc Changes
2015-11-05 05:52:53 -05:00
Hugo is a static HTML and CSS website generator written in [Go][].
Improve README All-around improvements to the README. Each sentence now gets its own line to eliminate ultra-long lines in the source (expect in bullet points--separating a bullet point into multiple lines looks weird and decreases readability). HTTPS links are now preferred to HTTP links and used where applicable. Link to Mercurial's website corrected to www.mercurial-scm.org Link to Hugo's docs is now accessible with [Hugo Documentatio][] since it is used more than once in the README. Multiline code blocks are now fenced rather than indented and include syntax highlighting.
2015-10-19 18:53:22 -04:00
It is optimized for speed, easy use and configurability.
Hugo takes a directory with content and templates and renders them into a full HTML website.
updating readme
2013-07-04 11:34:22 -04:00
Improve README All-around improvements to the README. Each sentence now gets its own line to eliminate ultra-long lines in the source (expect in bullet points--separating a bullet point into multiple lines looks weird and decreases readability). HTTPS links are now preferred to HTTP links and used where applicable. Link to Mercurial's website corrected to www.mercurial-scm.org Link to Hugo's docs is now accessible with [Hugo Documentatio][] since it is used more than once in the README. Multiline code blocks are now fenced rather than indented and include syntax highlighting.
2015-10-19 18:53:22 -04:00
Hugo relies on Markdown files with front matter for meta data.
And you can run Hugo from any directory.
This works well for shared hosts and other systems where you don’t have a privileged account.
updating readme
2013-07-04 11:34:22 -04:00
Improve README All-around improvements to the README. Each sentence now gets its own line to eliminate ultra-long lines in the source (expect in bullet points--separating a bullet point into multiple lines looks weird and decreases readability). HTTPS links are now preferred to HTTP links and used where applicable. Link to Mercurial's website corrected to www.mercurial-scm.org Link to Hugo's docs is now accessible with [Hugo Documentatio][] since it is used more than once in the README. Multiline code blocks are now fenced rather than indented and include syntax highlighting.
2015-10-19 18:53:22 -04:00
Hugo renders a typical website of moderate size in a fraction of a second.
A good rule of thumb is that each piece of content renders in around 1 millisecond.
Shrinking the readme to just the basics to avoid dupe with doc site
2013-08-03 03:31:25 -04:00
Small Doc Changes
2015-11-05 05:52:53 -05:00
Hugo is designed to work well for any kind of website including blogs, tumbles and docs.
updating readme
2013-07-04 11:34:22 -04:00
Tighten README for the sloppy reader Tighten README for the sloppy reader Tighten README for the sloppy reader Fixing heads tigheten markdown tighten markdown tighten markdown tinker with headings tinker with wording fixing period spacing moving the any dir stuff into the feature section tweak overview tweak overview fixed option too fix break:
2015-02-01 00:00:18 -05:00
#### Supported Architectures
updating readme
2013-07-04 11:34:22 -04: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 01:26:34 -05:00
Currently, we provide pre-built Hugo binaries for Windows, Linux, FreeBSD, NetBSD and OS X (Darwin) for x64, i386 and ARM 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 15:42:15 -05: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 01:26:34 -05: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 9 and Solaris.
better install instructions and fixing usage typo
2013-07-05 00:35:11 -04:00
Improve README All-around improvements to the README. Each sentence now gets its own line to eliminate ultra-long lines in the source (expect in bullet points--separating a bullet point into multiple lines looks weird and decreases readability). HTTPS links are now preferred to HTTP links and used where applicable. Link to Mercurial's website corrected to www.mercurial-scm.org Link to Hugo's docs is now accessible with [Hugo Documentatio][] since it is used more than once in the README. Multiline code blocks are now fenced rather than indented and include syntax highlighting.
2015-10-19 18:53:22 -04:00
**Complete documentation is available at [Hugo Documentation][].**
better install instructions and fixing usage typo
2013-07-05 00:35:11 -04:00
Tighten README for the sloppy reader Tighten README for the sloppy reader Tighten README for the sloppy reader Fixing heads tigheten markdown tighten markdown tighten markdown tinker with headings tinker with wording fixing period spacing moving the any dir stuff into the feature section tweak overview tweak overview fixed option too fix break:
2015-02-01 00:00:18 -05:00
## Choose How to Install
Improving installation instructions
2013-07-24 11:43:23 -04:00
Improve README All-around improvements to the README. Each sentence now gets its own line to eliminate ultra-long lines in the source (expect in bullet points--separating a bullet point into multiple lines looks weird and decreases readability). HTTPS links are now preferred to HTTP links and used where applicable. Link to Mercurial's website corrected to www.mercurial-scm.org Link to Hugo's docs is now accessible with [Hugo Documentatio][] since it is used more than once in the README. Multiline code blocks are now fenced rather than indented and include syntax highlighting.
2015-10-19 18:53:22 -04:00
If you want to use Hugo as your site generator, simply install the Hugo binaries.
The Hugo binaries have no external dependencies.
updating readme
2013-07-04 11:34:22 -04:00
Improve README All-around improvements to the README. Each sentence now gets its own line to eliminate ultra-long lines in the source (expect in bullet points--separating a bullet point into multiple lines looks weird and decreases readability). HTTPS links are now preferred to HTTP links and used where applicable. Link to Mercurial's website corrected to www.mercurial-scm.org Link to Hugo's docs is now accessible with [Hugo Documentatio][] since it is used more than once in the README. Multiline code blocks are now fenced rather than indented and include syntax highlighting.
2015-10-19 18:53:22 -04:00
To contribute to the Hugo source code or documentation, you should [fork the Hugo GitHub project](https://github.com/spf13/hugo#fork-destination-box) and clone it to your local machine.
updating readme
2013-07-04 11:34:22 -04:00
Fix README.md to list the correct -ldflags for Go 1.5+ Also remove extraneous trailing space (whitespace-mode from emacs). See also #1365
2016-02-04 12:25:41 -05:00
Finally, you can install the Hugo source code with `go`, build the binaries yourself, and run Hugo that way.
Improve README All-around improvements to the README. Each sentence now gets its own line to eliminate ultra-long lines in the source (expect in bullet points--separating a bullet point into multiple lines looks weird and decreases readability). HTTPS links are now preferred to HTTP links and used where applicable. Link to Mercurial's website corrected to www.mercurial-scm.org Link to Hugo's docs is now accessible with [Hugo Documentatio][] since it is used more than once in the README. Multiline code blocks are now fenced rather than indented and include syntax highlighting.
2015-10-19 18:53:22 -04:00
Building the binaries is an easy task for an experienced `go` getter.
updating readme
2013-07-04 11:34:22 -04:00
Tighten README for the sloppy reader Tighten README for the sloppy reader Tighten README for the sloppy reader Fixing heads tigheten markdown tighten markdown tighten markdown tinker with headings tinker with wording fixing period spacing moving the any dir stuff into the feature section tweak overview tweak overview fixed option too fix break:
2015-02-01 00:00:18 -05:00
### Install Hugo as Your Site Generator (Binary Install)
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 15:42:15 -05:00
docs: Use HTTPS links in README where appropriate
2016-03-02 13:54:56 -05:00
Use the [installation instructions in the Hugo documentation](https://gohugo.io/overview/installing/).
adding better install directions
2013-07-04 13:03:16 -04:00
Tighten README for the sloppy reader Tighten README for the sloppy reader Tighten README for the sloppy reader Fixing heads tigheten markdown tighten markdown tighten markdown tinker with headings tinker with wording fixing period spacing moving the any dir stuff into the feature section tweak overview tweak overview fixed option too fix break:
2015-02-01 00:00:18 -05:00
### Build and Install the Binaries from Source (Advanced Install)
Improving installation instructions
2013-07-24 11:43:23 -04:00
Tighten README for the sloppy reader Tighten README for the sloppy reader Tighten README for the sloppy reader Fixing heads tigheten markdown tighten markdown tighten markdown tinker with headings tinker with wording fixing period spacing moving the any dir stuff into the feature section tweak overview tweak overview fixed option too fix break:
2015-02-01 00:00:18 -05:00
Add Hugo and its package dependencies to your go `src` directory.
Merge branch 'doc-fix' of https://github.com/brandonblack/hugo into brandonblack-doc-fix Conflicts: README.md
2013-07-24 11:27:03 -04:00
More proofreading and minor revisions to Hugo docs Among the various changes, most instances of {{ template "partials/FILE.html" . }} were changed to {{ partial "FILE.html" . }} Also, in main.go, change "2013" to "2013-14".
2014-09-03 00:12:26 -04:00
go get -v github.com/spf13/hugo
adding better install directions
2013-07-04 13:03:16 -04:00
Tighten README for the sloppy reader Tighten README for the sloppy reader Tighten README for the sloppy reader Fixing heads tigheten markdown tighten markdown tighten markdown tinker with headings tinker with wording fixing period spacing moving the any dir stuff into the feature section tweak overview tweak overview fixed option too fix break:
2015-02-01 00:00:18 -05:00
Once the `get` completes, you should find your new `hugo` (or `hugo.exe`) executable sitting inside `$GOPATH/bin/`.
[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-27 21:17:09 -05:00
Tighten README for the sloppy reader Tighten README for the sloppy reader Tighten README for the sloppy reader Fixing heads tigheten markdown tighten markdown tighten markdown tinker with headings tinker with wording fixing period spacing moving the any dir stuff into the feature section tweak overview tweak overview fixed option too fix break:
2015-02-01 00:00:18 -05:00
To update Hugo’s dependencies, use `go get` with the `-u` option.
[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-27 21:17:09 -05:00
go get -u -v github.com/spf13/hugo
hugo: Update contribution guidelines Refactor the contribution guidelines in the README and CONTRIBUTING files. Simplify the contribution guide in the README and move most of the complex stuff into CONTRIBUTING. Add an explicit commit message guidelines section to CONTRIBUTING. Keep all of the guidelines from Chris Beams except for the 72 character line limit (we don't follow that, nor does the Go team). Add three new guidelines: package prefix in subject, references in body, and encouragement of message body in general. Add a new section to CONTRIBUTING on using Git Remotes.
2016-03-12 18:35:06 -05:00
## Contributing to Hugo
Update Readme.md with additional contribution guides
2015-03-04 09:01:15 -05:00
hugo: Update contribution guidelines Refactor the contribution guidelines in the README and CONTRIBUTING files. Simplify the contribution guide in the README and move most of the complex stuff into CONTRIBUTING. Add an explicit commit message guidelines section to CONTRIBUTING. Keep all of the guidelines from Chris Beams except for the 72 character line limit (we don't follow that, nor does the Go team). Add three new guidelines: package prefix in subject, references in body, and encouragement of message body in general. Add a new section to CONTRIBUTING on using Git Remotes.
2016-03-12 18:35:06 -05:00
For a complete guide to contributing to Hugo, see the [Contribution Guide](CONTRIBUTING.md).
Update Readme.md with additional contribution guides
2015-03-04 09:01:15 -05:00
hugo: Update contribution guidelines Refactor the contribution guidelines in the README and CONTRIBUTING files. Simplify the contribution guide in the README and move most of the complex stuff into CONTRIBUTING. Add an explicit commit message guidelines section to CONTRIBUTING. Keep all of the guidelines from Chris Beams except for the 72 character line limit (we don't follow that, nor does the Go team). Add three new guidelines: package prefix in subject, references in body, and encouragement of message body in general. Add a new section to CONTRIBUTING on using Git Remotes.
2016-03-12 18:35:06 -05:00
We welcome contributions to Hugo of any kind including documentation, themes,
organization, tutorials, blog posts, bug reports, issues, feature requests,
feature implementations, pull requests, answering questions on the forum,
helping to manage issues, etc.
Update Readme.md with additional contribution guides
2015-03-04 09:01:15 -05:00
Remove waffle.io graph from README Waffle.io's throughput graph appears to be broken. Remove the graph and simply link to GitHub's Pulse page. Fixes #2865
2017-01-02 06:02:27 -05:00
The Hugo community and maintainers are [very active](https://github.com/spf13/hugo/pulse/monthly) and helpful, and the project benefits greatly from this activity.
update README.md with info on adding compile information to version
2014-11-05 20:01:03 -05:00
hugo: Update contribution guidelines Refactor the contribution guidelines in the README and CONTRIBUTING files. Simplify the contribution guide in the README and move most of the complex stuff into CONTRIBUTING. Add an explicit commit message guidelines section to CONTRIBUTING. Keep all of the guidelines from Chris Beams except for the 72 character line limit (we don't follow that, nor does the Go team). Add three new guidelines: package prefix in subject, references in body, and encouragement of message body in general. Add a new section to CONTRIBUTING on using Git Remotes.
2016-03-12 18:35:06 -05:00
### Asking Support Questions
update README.md with info on adding compile information to version
2014-11-05 20:01:03 -05:00
hugo: Update contribution guidelines Refactor the contribution guidelines in the README and CONTRIBUTING files. Simplify the contribution guide in the README and move most of the complex stuff into CONTRIBUTING. Add an explicit commit message guidelines section to CONTRIBUTING. Keep all of the guidelines from Chris Beams except for the 72 character line limit (we don't follow that, nor does the Go team). Add three new guidelines: package prefix in subject, references in body, and encouragement of message body in general. Add a new section to CONTRIBUTING on using Git Remotes.
2016-03-12 18:35:06 -05:00
We have an active [discussion forum](http://discuss.gohugo.io) where users and developers can ask questions.
Please don't use the Github issue tracker to ask questions.
update README.md with info on adding compile information to version
2014-11-05 20:01:03 -05:00
hugo: Update contribution guidelines Refactor the contribution guidelines in the README and CONTRIBUTING files. Simplify the contribution guide in the README and move most of the complex stuff into CONTRIBUTING. Add an explicit commit message guidelines section to CONTRIBUTING. Keep all of the guidelines from Chris Beams except for the 72 character line limit (we don't follow that, nor does the Go team). Add three new guidelines: package prefix in subject, references in body, and encouragement of message body in general. Add a new section to CONTRIBUTING on using Git Remotes.
2016-03-12 18:35:06 -05:00
### Reporting Issues
update README.md with info on adding compile information to version
2014-11-05 20:01:03 -05:00
hugo: Update contribution guidelines Refactor the contribution guidelines in the README and CONTRIBUTING files. Simplify the contribution guide in the README and move most of the complex stuff into CONTRIBUTING. Add an explicit commit message guidelines section to CONTRIBUTING. Keep all of the guidelines from Chris Beams except for the 72 character line limit (we don't follow that, nor does the Go team). Add three new guidelines: package prefix in subject, references in body, and encouragement of message body in general. Add a new section to CONTRIBUTING on using Git Remotes.
2016-03-12 18:35:06 -05:00
If you believe you have found a defect in Hugo or its documentation, use
the Github issue tracker to report the problem to the Hugo maintainers.
If you're not sure if it's a bug or not, start by asking in the [discussion forum](http://discuss.gohugo.io).
When reporting the issue, please provide the version of Hugo in use (`hugo version`).
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 15:42:15 -05:00
hugo: Update contribution guidelines Refactor the contribution guidelines in the README and CONTRIBUTING files. Simplify the contribution guide in the README and move most of the complex stuff into CONTRIBUTING. Add an explicit commit message guidelines section to CONTRIBUTING. Keep all of the guidelines from Chris Beams except for the 72 character line limit (we don't follow that, nor does the Go team). Add three new guidelines: package prefix in subject, references in body, and encouragement of message body in general. Add a new section to CONTRIBUTING on using Git Remotes.
2016-03-12 18:35:06 -05:00
### Submitting Patches
updating readme
2013-07-04 11:34:22 -04:00
hugo: Update contribution guidelines Refactor the contribution guidelines in the README and CONTRIBUTING files. Simplify the contribution guide in the README and move most of the complex stuff into CONTRIBUTING. Add an explicit commit message guidelines section to CONTRIBUTING. Keep all of the guidelines from Chris Beams except for the 72 character line limit (we don't follow that, nor does the Go team). Add three new guidelines: package prefix in subject, references in body, and encouragement of message body in general. Add a new section to CONTRIBUTING on using Git Remotes.
2016-03-12 18:35:06 -05:00
The Hugo project welcomes all contributors and contributions regardless of skill or experience level.
If you are interested in helping with the project, we will help you with your contribution.
Hugo is a very active project with many contributions happening daily.
Because we want to create the best possible product for our users and the best contribution experience for our developers,
we have a set of guidelines which ensure that all contributions are acceptable.
The guidelines are not intended as a filter or barrier to participation.
If you are unfamiliar with the contribution process, the Hugo team will help you and teach you how to bring your contribution in accordance with the guidelines.
updating readme
2013-07-04 11:34:22 -04:00
hugo: Update contribution guidelines Refactor the contribution guidelines in the README and CONTRIBUTING files. Simplify the contribution guide in the README and move most of the complex stuff into CONTRIBUTING. Add an explicit commit message guidelines section to CONTRIBUTING. Keep all of the guidelines from Chris Beams except for the 72 character line limit (we don't follow that, nor does the Go team). Add three new guidelines: package prefix in subject, references in body, and encouragement of message body in general. Add a new section to CONTRIBUTING on using Git Remotes.
2016-03-12 18:35:06 -05:00
For a complete guide to contributing code to Hugo, see the [Contribution Guide](CONTRIBUTING.md).
Adding some analytics
2014-01-03 12:58:09 -05:00
[![Analytics](https://ga-beacon.appspot.com/UA-7131036-6/hugo/readme)](https://github.com/igrigorik/ga-beacon)
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 15:42:15 -05:00
Improve README All-around improvements to the README. Each sentence now gets its own line to eliminate ultra-long lines in the source (expect in bullet points--separating a bullet point into multiple lines looks weird and decreases readability). HTTPS links are now preferred to HTTP links and used where applicable. Link to Mercurial's website corrected to www.mercurial-scm.org Link to Hugo's docs is now accessible with [Hugo Documentatio][] since it is used more than once in the README. Multiline code blocks are now fenced rather than indented and include syntax highlighting.
2015-10-19 18:53:22 -04:00
[Go]: https://golang.org/
fixed documentation link
2015-11-19 18:24:41 -05:00
[Hugo Documentation]: https://gohugo.io/overview/introduction/
Reference in a new issue Copy permalink