github.com/neohugo/neohugo@v0.123.8/README.md (about)

     1  A [hugo](https://github.com/gohugoio/hugo)-fork focused on multilingual and Custom format Feature(specific AMP) with other bug fixes/refactor/cleanup.
     2  
     3  what is the different between neohugo vs hugo?
     4  
     5  [Neohugo vs Hugo](https://github.com/neohugo/neohugo/wiki/Diff-hugo-neohugo)
     6  
     7  
     8  [Website](https://neohugo.github.io) |
     9  [Forum](https://github.com/neohugo/neohugo/discussions) |
    10  [Documentation](https://neohugo.github.io/getting-started/) |
    11  [Installation Guide](https://neohugo.github.io/getting-started/installing/) |
    12  [Contribution Guide](CONTRIBUTING.md)
    13  
    14  [![Go Reference](https://pkg.go.dev/badge/neohugo/neohugo.svg)](https://pkg.go.dev/github.com/neohugo/neohugo)
    15  ![Golangci-lint](https://github.com/neohugo/neohugo/workflows/Golangci-lint/badge.svg)
    16  ![CI](https://github.com/neohugo/neohugo/workflows/CI/badge.svg)
    17  ![Release](https://github.com/neohugo/neohugo/workflows/Release/badge.svg)
    18  [![Go Report Card](https://goreportcard.com/badge/github.com/neohugo/neohugo)](https://goreportcard.com/report/github.com/neohugo/neohugo)
    19  
    20  [Website] | [Installation] | [Documentation] | [Support] | [Contributing] | <a rel="me" href="https://fosstodon.org/@gohugoio">Mastodon</a>
    21  
    22  ## Overview
    23  
    24  Hugo is a [static site generator] written in [Go], optimized for speed and designed for flexibility. With its advanced templating system and fast asset pipelines, Hugo renders a complete site in seconds, often less.
    25  
    26  Due to its flexible framework, multilingual support, and powerful taxonomy system, Hugo is widely used to create:
    27  
    28  - Corporate, government, nonprofit, education, news, event, and project sites
    29  - Documentation sites
    30  - Image portfolios
    31  - Landing pages
    32  - Business, professional, and personal blogs
    33  - Resumes and CVs
    34  
    35  Use Hugo's embedded web server during development to instantly see changes to content, structure, behavior, and presentation. Then deploy the site to your host, or push changes to your Git provider for automated builds and deployment.
    36  
    37  Hugo's fast asset pipelines include:
    38  
    39  - CSS bundling &ndash; transpilation (Sass), tree shaking, minification, source maps, SRI hashing, and PostCSS integration
    40  - JavaScript bundling &ndash; transpilation (TypeScript, JSX), tree shaking, minification, source maps, and SRI hashing
    41  - Image processing &ndash; convert, resize, crop, rotate,  adjust colors, apply filters, overlay text and images, and extract EXIF data
    42  
    43  And with [Hugo Modules], you can share content, assets, data, translations, themes, templates, and configuration with other projects via public or private Git repositories.
    44  
    45  ## Sponsors
    46  
    47  <p>&nbsp;</p>
    48  <p float="left">
    49    <a href="https://www.linode.com/?utm_campaign=hugosponsor&utm_medium=banner&utm_source=hugogithub" target="_blank"><img src="https://raw.githubusercontent.com/gohugoio/gohugoioTheme/master/assets/images/sponsors/linode-logo_standard_light_medium.png" width="200" alt="Linode"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
    50    <a href="https://cloudcannon.com/hugo-cms/?utm_campaign=HugoSponsorship&utm_source=sponsor&utm_content=gohugo" target="_blank"><img src="https://raw.githubusercontent.com/gohugoio/gohugoioTheme/master/assets/images/sponsors/cloudcannon-blue.svg" width="220" alt="CloudCannon"></a>
    51  <p>&nbsp;</p>
    52  
    53  ## Installation
    54  
    55  Install Hugo from a [prebuilt binary], package manager, or package repository. Please see the installation instructions for your operating system:
    56  
    57  - [macOS]
    58  - [Linux]
    59  - [Windows]
    60  - [DragonFly BSD, FreeBSD, NetBSD, and OpenBSD]
    61  
    62  ## Build from source
    63  
    64  Hugo is available in two editions: standard and extended. With the extended edition you can:
    65  
    66  - Encode to the WebP format when processing images. You can decode WebP images with either edition.
    67  - Transpile Sass to CSS using the embedded LibSass transpiler. The extended edition is not required to use the Dart Sass transpiler.
    68  
    69  Prerequisites to build Hugo from source:
    70  
    71  - Standard edition: Go 1.20 or later
    72  - Extended edition: Go 1.20 or later, and GCC
    73  
    74  Build the standard edition:
    75  
    76  ```text
    77  go install github.com/gohugoio/hugo@latest
    78  ```
    79  
    80  Build the extended edition:
    81  
    82  ```text
    83  CGO_ENABLED=1 go install -tags extended github.com/gohugoio/hugo@latest
    84  ```
    85  
    86  ## Documentation
    87  
    88  Hugo's [documentation] includes installation instructions, a quick start guide, conceptual explanations, reference information, and examples.
    89  
    90  Please submit documentation issues and pull requests to the [documentation repository].
    91  
    92  ## Support
    93  
    94  Please **do not use the issue queue** for questions or troubleshooting. Unless you are certain that your issue is a software defect, use the [forum].
    95  
    96  Hugo’s [forum] is an active community of users and developers who answer questions, share knowledge, and provide examples. A quick search of over 20,000 topics will often answer your question. Please be sure to read about [requesting help] before asking your first question.
    97  
    98  ## Contributing
    99  
   100  You can contribute to the Hugo project by:
   101  
   102  - Answering questions on the [forum]
   103  - Improving the [documentation]
   104  - Monitoring the [issue queue]
   105  - Creating or improving [themes]
   106  - Squashing [bugs]
   107  
   108  Please submit documentation issues and pull requests to the [documentation repository].
   109  
   110  If you have an idea for an enhancement or new feature, create a new topic on the [forum] in the "Feature" category. This will help you to:
   111  
   112  - Determine if the capability already exists
   113  - Measure interest
   114  - Refine the concept
   115  
   116  If there is sufficient interest, [create a proposal]. Do not submit a pull request until the project lead accepts the proposal.
   117  
   118  For a complete guide to contributing to Hugo, see the [Contribution Guide](CONTRIBUTING.md).
   119  
   120  ## Dependencies
   121  
   122  Hugo stands on the shoulders of great open source libraries. Run `hugo env --logLevel info` to display a list of dependencies.
   123  
   124  <details>
   125  <summary>See current dependencies</summary>
   126  
   127  ```text
   128  cloud.google.com/go/compute/metadata="v0.2.3"
   129  cloud.google.com/go/iam="v1.1.3"
   130  cloud.google.com/go/storage="v1.31.0"
   131  cloud.google.com/go="v0.110.8"
   132  github.com/Azure/azure-sdk-for-go/sdk/azcore="v1.7.0"
   133  github.com/Azure/azure-sdk-for-go/sdk/azidentity="v1.3.0"
   134  github.com/Azure/azure-sdk-for-go/sdk/internal="v1.3.0"
   135  github.com/Azure/azure-sdk-for-go/sdk/storage/azblob="v1.1.0"
   136  github.com/Azure/go-autorest/autorest/to="v0.4.0"
   137  github.com/AzureAD/microsoft-authentication-library-for-go="v1.0.0"
   138  github.com/BurntSushi/locker="v0.0.0-20171006230638-a6e239ea1c69"
   139  github.com/PuerkitoBio/purell="v1.1.1"
   140  github.com/PuerkitoBio/urlesc="v0.0.0-20170810143723-de5bf2ad4578"
   141  github.com/alecthomas/chroma/v2="v2.11.1"
   142  github.com/armon/go-radix="v1.0.0"
   143  github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream="v1.4.11"
   144  github.com/aws/aws-sdk-go-v2/config="v1.18.32"
   145  github.com/aws/aws-sdk-go-v2/credentials="v1.13.31"
   146  github.com/aws/aws-sdk-go-v2/feature/ec2/imds="v1.13.7"
   147  github.com/aws/aws-sdk-go-v2/feature/s3/manager="v1.11.76"
   148  github.com/aws/aws-sdk-go-v2/internal/configsources="v1.1.37"
   149  github.com/aws/aws-sdk-go-v2/internal/endpoints/v2="v2.4.31"
   150  github.com/aws/aws-sdk-go-v2/internal/ini="v1.3.38"
   151  github.com/aws/aws-sdk-go-v2/internal/v4a="v1.1.0"
   152  github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding="v1.9.12"
   153  github.com/aws/aws-sdk-go-v2/service/internal/checksum="v1.1.32"
   154  github.com/aws/aws-sdk-go-v2/service/internal/presigned-url="v1.9.31"
   155  github.com/aws/aws-sdk-go-v2/service/internal/s3shared="v1.15.0"
   156  github.com/aws/aws-sdk-go-v2/service/s3="v1.38.1"
   157  github.com/aws/aws-sdk-go-v2/service/sso="v1.13.1"
   158  github.com/aws/aws-sdk-go-v2/service/ssooidc="v1.15.1"
   159  github.com/aws/aws-sdk-go-v2/service/sts="v1.21.1"
   160  github.com/aws/aws-sdk-go-v2="v1.20.0"
   161  github.com/aws/aws-sdk-go="v1.48.2"
   162  github.com/aws/smithy-go="v1.14.0"
   163  github.com/bep/clocks="v0.5.0"
   164  github.com/bep/debounce="v1.2.0"
   165  github.com/bep/gitmap="v1.1.2"
   166  github.com/bep/goat="v0.5.0"
   167  github.com/bep/godartsass/v2="v2.0.0"
   168  github.com/bep/godartsass="v1.2.0"
   169  github.com/bep/golibsass="v1.1.1"
   170  github.com/bep/gowebp="v0.3.0"
   171  github.com/bep/lazycache="v0.2.0"
   172  github.com/bep/logg="v0.3.0"
   173  github.com/bep/mclib="v1.20400.20402"
   174  github.com/bep/overlayfs="v0.6.0"
   175  github.com/bep/simplecobra="v0.3.2"
   176  github.com/bep/tmc="v0.5.1"
   177  github.com/clbanning/mxj/v2="v2.7.0"
   178  github.com/cli/safeexec="v1.0.1"
   179  github.com/cpuguy83/go-md2man/v2="v2.0.2"
   180  github.com/disintegration/gift="v1.2.1"
   181  github.com/dlclark/regexp2="v1.10.0"
   182  github.com/dustin/go-humanize="v1.0.1"
   183  github.com/evanw/esbuild="v0.19.7"
   184  github.com/fatih/color="v1.16.0"
   185  github.com/frankban/quicktest="v1.14.6"
   186  github.com/fsnotify/fsnotify="v1.7.0"
   187  github.com/getkin/kin-openapi="v0.120.0"
   188  github.com/ghodss/yaml="v1.0.0"
   189  github.com/go-openapi/jsonpointer="v0.19.6"
   190  github.com/go-openapi/swag="v0.22.4"
   191  github.com/gobuffalo/flect="v1.0.2"
   192  github.com/gobwas/glob="v0.2.3"
   193  github.com/gohugoio/go-i18n/v2="v2.1.3-0.20230805085216-e63c13218d0e"
   194  github.com/gohugoio/locales="v0.14.0"
   195  github.com/gohugoio/localescompressed="v1.0.1"
   196  github.com/golang-jwt/jwt/v4="v4.5.0"
   197  github.com/golang/groupcache="v0.0.0-20210331224755-41bb18bfe9da"
   198  github.com/golang/protobuf="v1.5.3"
   199  github.com/google/go-cmp="v0.6.0"
   200  github.com/google/s2a-go="v0.1.7"
   201  github.com/google/uuid="v1.4.0"
   202  github.com/google/wire="v0.5.0"
   203  github.com/googleapis/enterprise-certificate-proxy="v0.3.2"
   204  github.com/googleapis/gax-go/v2="v2.12.0"
   205  github.com/gorilla/websocket="v1.5.1"
   206  github.com/hairyhenderson/go-codeowners="v0.4.0"
   207  github.com/hashicorp/golang-lru/v2="v2.0.1"
   208  github.com/invopop/yaml="v0.2.0"
   209  github.com/jdkato/prose="v1.2.1"
   210  github.com/jmespath/go-jmespath="v0.4.0"
   211  github.com/josharian/intern="v1.0.0"
   212  github.com/kr/pretty="v0.3.1"
   213  github.com/kr/text="v0.2.0"
   214  github.com/kylelemons/godebug="v1.1.0"
   215  github.com/kyokomi/emoji/v2="v2.2.12"
   216  github.com/mailru/easyjson="v0.7.7"
   217  github.com/marekm4/color-extractor="v1.2.1"
   218  github.com/mattn/go-colorable="v0.1.13"
   219  github.com/mattn/go-isatty="v0.0.20"
   220  github.com/mattn/go-runewidth="v0.0.9"
   221  github.com/mitchellh/hashstructure="v1.1.0"
   222  github.com/mitchellh/mapstructure="v1.5.0"
   223  github.com/mohae/deepcopy="v0.0.0-20170929034955-c48cc78d4826"
   224  github.com/muesli/smartcrop="v0.3.0"
   225  github.com/niklasfasching/go-org="v1.7.0"
   226  github.com/olekukonko/tablewriter="v0.0.5"
   227  github.com/pelletier/go-toml/v2="v2.1.0"
   228  github.com/perimeterx/marshmallow="v1.1.5"
   229  github.com/pkg/browser="v0.0.0-20210911075715-681adbf594b8"
   230  github.com/pkg/errors="v0.9.1"
   231  github.com/rogpeppe/go-internal="v1.11.0"
   232  github.com/russross/blackfriday/v2="v2.1.0"
   233  github.com/rwcarlsen/goexif="v0.0.0-20190401172101-9e8deecbddbd"
   234  github.com/sanity-io/litter="v1.5.5"
   235  github.com/sass/dart-sass/compiler="1.63.2"
   236  github.com/sass/dart-sass/implementation="1.63.2"
   237  github.com/sass/dart-sass/protocol="2.0.0"
   238  github.com/sass/libsass="3.6.5"
   239  github.com/spf13/afero="v1.10.0"
   240  github.com/spf13/cast="v1.5.1"
   241  github.com/spf13/cobra="v1.7.0"
   242  github.com/spf13/fsync="v0.9.0"
   243  github.com/spf13/pflag="v1.0.5"
   244  github.com/tdewolff/minify/v2="v2.20.7"
   245  github.com/tdewolff/parse/v2="v2.7.5"
   246  github.com/webmproject/libwebp="v1.3.2"
   247  github.com/yuin/goldmark-emoji="v1.0.2"
   248  github.com/yuin/goldmark="v1.6.0"
   249  go.opencensus.io="v0.24.0"
   250  go.uber.org/atomic="v1.11.0"
   251  go.uber.org/automaxprocs="v1.5.3"
   252  gocloud.dev="v0.34.0"
   253  golang.org/x/crypto="v0.15.0"
   254  golang.org/x/exp="v0.0.0-20221031165847-c99f073a8326"
   255  golang.org/x/image="v0.13.0"
   256  golang.org/x/mod="v0.14.0"
   257  golang.org/x/net="v0.18.0"
   258  golang.org/x/oauth2="v0.13.0"
   259  golang.org/x/sync="v0.5.0"
   260  golang.org/x/sys="v0.14.0"
   261  golang.org/x/text="v0.14.0"
   262  golang.org/x/time="v0.3.0"
   263  golang.org/x/tools="v0.15.0"
   264  golang.org/x/xerrors="v0.0.0-20220907171357-04be3eba64a2"
   265  google.golang.org/api="v0.151.0"
   266  google.golang.org/genproto/googleapis/api="v0.0.0-20231016165738-49dd2c1f3d0b"
   267  google.golang.org/genproto/googleapis/rpc="v0.0.0-20231030173426-d783a09b4405"
   268  google.golang.org/genproto="v0.0.0-20231016165738-49dd2c1f3d0b"
   269  google.golang.org/grpc="v1.59.0"
   270  google.golang.org/protobuf="v1.31.0"
   271  gopkg.in/yaml.v2="v2.4.0"
   272  gopkg.in/yaml.v3="v3.0.1"
   273  howett.net/plist="v1.0.0"
   274  software.sslmate.com/src/go-pkcs12="v0.2.0"
   275  ```
   276  </details>