github.com/gohugoio/hugo@v0.88.1/README.md (about)

     1  <img src="https://raw.githubusercontent.com/gohugoio/gohugoioTheme/master/static/images/hugo-logo-wide.svg?sanitize=true" alt="Hugo" width="565">
     2  
     3  A Fast and Flexible Static Site Generator built with love by [bep](https://github.com/bep), [spf13](http://spf13.com/) and [friends](https://github.com/gohugoio/hugo/graphs/contributors) in [Go][].
     4  
     5  [Website](https://gohugo.io) |
     6  [Forum](https://discourse.gohugo.io) |
     7  [Documentation](https://gohugo.io/getting-started/) |
     8  [Installation Guide](https://gohugo.io/getting-started/installing/) |
     9  [Contribution Guide](CONTRIBUTING.md) |
    10  [Twitter](https://twitter.com/gohugoio)
    11  
    12  [![GoDoc](https://godoc.org/github.com/gohugoio/hugo?status.svg)](https://godoc.org/github.com/gohugoio/hugo)
    13  [![Tests on Linux, MacOS and Windows](https://github.com/gohugoio/hugo/workflows/Test/badge.svg)](https://github.com/gohugoio/hugo/actions?query=workflow%3ATest)
    14  [![Go Report Card](https://goreportcard.com/badge/github.com/gohugoio/hugo)](https://goreportcard.com/report/github.com/gohugoio/hugo)
    15  
    16  ## Overview
    17  
    18  Hugo is a static HTML and CSS website generator written in [Go][].
    19  It is optimized for speed, ease of use, and configurability.
    20  Hugo takes a directory with content and templates and renders them into a full HTML website.
    21  
    22  Hugo relies on Markdown files with front matter for metadata, and you can run Hugo from any directory.
    23  This works well for shared hosts and other systems where you don’t have a privileged account.
    24  
    25  Hugo renders a typical website of moderate size in a fraction of a second.
    26  A good rule of thumb is that each piece of content renders in around 1 millisecond.
    27  
    28  Hugo is designed to work well for any kind of website including blogs, tumbles, and docs.
    29  
    30  #### Supported Architectures
    31  
    32  Currently, we provide pre-built Hugo binaries for Windows, Linux, FreeBSD, NetBSD, DragonFly BSD, Open BSD, macOS (Darwin), and [Android](https://gist.github.com/bep/a0d8a26cf6b4f8bc992729b8e50b480b) for x64, i386 and ARM architectures.
    33  
    34  Hugo may also be compiled from source wherever the Go compiler tool chain can run, e.g. for other operating systems including Plan 9 and Solaris.
    35  
    36  **Complete documentation is available at [Hugo Documentation](https://gohugo.io/getting-started/).**
    37  
    38  ## Choose How to Install
    39  
    40  If you want to use Hugo as your site generator, simply install the Hugo binaries.
    41  The Hugo binaries have no external dependencies.
    42  
    43  To contribute to the Hugo source code or documentation, you should [fork the Hugo GitHub project](https://github.com/gohugoio/hugo#fork-destination-box) and clone it to your local machine.
    44  
    45  Finally, you can install the Hugo source code with `go`, build the binaries yourself, and run Hugo that way.
    46  Building the binaries is an easy task for an experienced `go` getter.
    47  
    48  ### Install Hugo as Your Site Generator (Binary Install)
    49  
    50  Use the [installation instructions in the Hugo documentation](https://gohugo.io/getting-started/installing/).
    51  
    52  ### Build and Install the Binaries from Source (Advanced Install)
    53  
    54  #### Prerequisite Tools
    55  
    56  * [Git](https://git-scm.com/)
    57  * [Go (we test it with the last 2 major versions; but note that Hugo 0.81.0 only builds with >= Go 1.16.)](https://golang.org/dl/)
    58  
    59  #### Fetch from GitHub
    60  
    61  Since Hugo 0.48, Hugo uses the Go Modules support built into Go 1.11 to build. The easiest is to clone Hugo in a directory outside of `GOPATH`, as in the following example:
    62  
    63  ```bash
    64  mkdir $HOME/src
    65  cd $HOME/src
    66  git clone https://github.com/gohugoio/hugo.git
    67  cd hugo
    68  go install
    69  ```
    70  
    71  **If you are a Windows user, substitute the `$HOME` environment variable above with `%USERPROFILE%`.**
    72  
    73  If you want to compile with Sass/SCSS support use `--tags extended` and make sure `CGO_ENABLED=1` is set in your go environment. If you don't want to have CGO enabled, you may use the following command to temporarily enable CGO only for hugo compilation:
    74  
    75  ```bash
    76  CGO_ENABLED=1 go install --tags extended
    77  ```
    78  
    79  ## The Hugo Documentation
    80  
    81  The Hugo documentation now lives in its own repository, see https://github.com/gohugoio/hugoDocs. But we do keep a version of that documentation as a `git subtree` in this repository. To build the sub folder `/docs` as a Hugo site, you need to clone this repo:
    82  
    83  ```bash
    84  git clone git@github.com:gohugoio/hugo.git
    85  ```
    86  ## Contributing to Hugo
    87  
    88  For a complete guide to contributing to Hugo, see the [Contribution Guide](CONTRIBUTING.md).
    89  
    90  We welcome contributions to Hugo of any kind including documentation, themes,
    91  organization, tutorials, blog posts, bug reports, issues, feature requests,
    92  feature implementations, pull requests, answering questions on the forum,
    93  helping to manage issues, etc.
    94  
    95  The Hugo community and maintainers are [very active](https://github.com/gohugoio/hugo/pulse/monthly) and helpful, and the project benefits greatly from this activity.
    96  
    97  ### Asking Support Questions
    98  
    99  We have an active [discussion forum](https://discourse.gohugo.io) where users and developers can ask questions.
   100  Please don't use the GitHub issue tracker to ask questions.
   101  
   102  ### Reporting Issues
   103  
   104  If you believe you have found a defect in Hugo or its documentation, use
   105  the GitHub issue tracker to report the problem to the Hugo maintainers.
   106  If you're not sure if it's a bug or not, start by asking in the [discussion forum](https://discourse.gohugo.io).
   107  When reporting the issue, please provide the version of Hugo in use (`hugo version`).
   108  
   109  ### Submitting Patches
   110  
   111  The Hugo project welcomes all contributors and contributions regardless of skill or experience level.
   112  If you are interested in helping with the project, we will help you with your contribution.
   113  Hugo is a very active project with many contributions happening daily.
   114  
   115  We want to create the best possible product for our users and the best contribution experience for our developers,
   116  we have a set of guidelines which ensure that all contributions are acceptable.
   117  The guidelines are not intended as a filter or barrier to participation.
   118  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.
   119  
   120  For a complete guide to contributing code to Hugo, see the [Contribution Guide](CONTRIBUTING.md).
   121  
   122  [![Analytics](https://ga-beacon.appspot.com/UA-7131036-6/hugo/readme)](https://github.com/igrigorik/ga-beacon)
   123  
   124  [Go]: https://golang.org/
   125  [Hugo Documentation]: https://gohugo.io/overview/introduction/
   126  
   127  ## Dependencies
   128  
   129  Hugo stands on the shoulder of many great open source libraries.
   130  
   131  If you run `hugo env -v` you will get a complete and up to date list.
   132  
   133  In Hugo 0.83.0 that list is, in lexical order:
   134  
   135  ```json
   136  cloud.google.com/go/storage="v1.10.0"
   137  cloud.google.com/go="v0.81.0"
   138  github.com/Azure/azure-pipeline-go="v0.2.2"
   139  github.com/Azure/azure-storage-blob-go="v0.9.0"
   140  github.com/BurntSushi/locker="v0.0.0-20171006230638-a6e239ea1c69"
   141  github.com/BurntSushi/toml="v0.3.1"
   142  github.com/PuerkitoBio/purell="v1.1.1"
   143  github.com/PuerkitoBio/urlesc="v0.0.0-20170810143723-de5bf2ad4578"
   144  github.com/alecthomas/chroma="v0.9.1"
   145  github.com/armon/go-radix="v1.0.0"
   146  github.com/aws/aws-sdk-go="v1.38.23"
   147  github.com/bep/debounce="v1.2.0"
   148  github.com/bep/gitmap="v1.1.2"
   149  github.com/bep/godartsass="v0.12.0"
   150  github.com/bep/gowebp="v0.1.0"
   151  github.com/bep/tmc="v0.5.1"
   152  github.com/cli/safeexec="v1.0.0"
   153  github.com/cpuguy83/go-md2man/v2="v2.0.0"
   154  github.com/danwakefield/fnmatch="v0.0.0-20160403171240-cbb64ac3d964"
   155  github.com/disintegration/gift="v1.2.1"
   156  github.com/dlclark/regexp2="v1.4.0"
   157  github.com/dustin/go-humanize="v1.0.0"
   158  github.com/evanw/esbuild="v0.11.16"
   159  github.com/fsnotify/fsnotify="v1.4.9"
   160  github.com/getkin/kin-openapi="v0.61.0"
   161  github.com/ghodss/yaml="v1.0.0"
   162  github.com/go-openapi/jsonpointer="v0.19.5"
   163  github.com/go-openapi/swag="v0.19.5"
   164  github.com/gobuffalo/flect="v0.2.2"
   165  github.com/gobwas/glob="v0.2.3"
   166  github.com/gohugoio/go-i18n/v2="v2.1.3-0.20210430103248-4c28c89f8013"
   167  github.com/golang/groupcache="v0.0.0-20200121045136-8c9f03a8e57e"
   168  github.com/golang/protobuf="v1.5.2"
   169  github.com/google/go-cmp="v0.5.5"
   170  github.com/google/uuid="v1.1.2"
   171  github.com/google/wire="v0.4.0"
   172  github.com/googleapis/gax-go/v2="v2.0.5"
   173  github.com/googleapis/gax-go="v2.0.2+incompatible"
   174  github.com/gorilla/websocket="v1.4.2"
   175  github.com/hashicorp/hcl="v1.0.0"
   176  github.com/jdkato/prose="v1.2.1"
   177  github.com/jmespath/go-jmespath="v0.4.0"
   178  github.com/kyokomi/emoji/v2="v2.2.8"
   179  github.com/magiconair/properties="v1.8.1"
   180  github.com/mailru/easyjson="v0.0.0-20190626092158-b2ccc519800e"
   181  github.com/mattn/go-ieproxy="v0.0.1"
   182  github.com/mattn/go-isatty="v0.0.12"
   183  github.com/mattn/go-runewidth="v0.0.9"
   184  github.com/miekg/mmark="v1.3.6"
   185  github.com/mitchellh/hashstructure="v1.0.0"
   186  github.com/mitchellh/mapstructure="v1.3.3"
   187  github.com/muesli/smartcrop="v0.3.0"
   188  github.com/niklasfasching/go-org="v1.5.0"
   189  github.com/olekukonko/tablewriter="v0.0.5"
   190  github.com/pelletier/go-toml="v1.9.0"
   191  github.com/pkg/errors="v0.9.1"
   192  github.com/rogpeppe/go-internal="v1.8.0"
   193  github.com/russross/blackfriday/v2="v2.0.1"
   194  github.com/russross/blackfriday="v1.5.3-0.20200218234912-41c5fccfd6f6"
   195  github.com/rwcarlsen/goexif="v0.0.0-20190401172101-9e8deecbddbd"
   196  github.com/sanity-io/litter="v1.5.0"
   197  github.com/shurcooL/sanitized_anchor_name="v1.0.0"
   198  github.com/spf13/afero="v1.6.0"
   199  github.com/spf13/cast="v1.3.1"
   200  github.com/spf13/cobra="v1.1.3"
   201  github.com/spf13/fsync="v0.9.0"
   202  github.com/spf13/jwalterweatherman="v1.1.0"
   203  github.com/spf13/pflag="v1.0.5"
   204  github.com/spf13/viper="v1.7.1"
   205  github.com/subosito/gotenv="v1.2.0"
   206  github.com/tdewolff/minify/v2="v2.9.16"
   207  github.com/tdewolff/parse/v2="v2.5.14"
   208  github.com/yuin/goldmark-highlighting="v0.0.0-20200307114337-60d527fdb691"
   209  github.com/yuin/goldmark="v1.3.5"
   210  go.opencensus.io="v0.23.0"
   211  gocloud.dev="v0.20.0"
   212  golang.org/x/image="v0.0.0-20210220032944-ac19c3e999fb"
   213  golang.org/x/net="v0.0.0-20210316092652-d523dce5a7f4"
   214  golang.org/x/oauth2="v0.0.0-20210413134643-5e61552d6c78"
   215  golang.org/x/sync="v0.0.0-20210220032951-036812b2e83c"
   216  golang.org/x/sys="v0.0.0-20210412220455-f1c623a9e750"
   217  golang.org/x/text="v0.3.6"
   218  golang.org/x/xerrors="v0.0.0-20200804184101-5ec99f83aff1"
   219  google.golang.org/api="v0.45.0"
   220  google.golang.org/genproto="v0.0.0-20210413151531-c14fb6ef47c3"
   221  google.golang.org/grpc="v1.37.0"
   222  google.golang.org/protobuf="v1.26.0"
   223  gopkg.in/ini.v1="v1.51.1"
   224  gopkg.in/yaml.v2="v2.4.0"
   225  
   226