mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
83bef6955e
e161ea09d Add one more Chinese file to workaround reflect: Zero(nil) b595b3a21 Add more Chinese translation 56e4e95d9 Use lang.Merge to "fill in the gaps" for untranslated pages ef079406c Merge commit '650fac3a4e7d256f4505402ab44cfc3c804b8dea' 650fac3a4 Squashed 'themes/gohugoioTheme/' changes from a1768ebb..f31a3dc8 322eff899 Add Chinese language for menus d90b886e0 Fix Markdown table syntax in previous commit 737f3dfca Update the leaf bundle vs branch bundle table 09fa1bc4e Clarify that `.Now` is obsolete 879ea3f6a Make release notes somewhat more consistent 0113e2051 Move 0.40.2-relnotes into content/en/news 77578f5bf Move content/ into new contentDir content/en/ 4dcf7c709 Fix "reflect: Zero(nil)" error in showcase 63dd25505 Release 0.40.2 2076c0d56 releaser: Prepare repository for 0.41-DEV 070fe565e releaser: Add release notes to /docs for release of 0.40.2 4ce52e913 releaser: Bump versions for release of 0.40.2 41907c487 Fix typos in syntax-highlighting.md 91753ef3d Add missing backtick b77274301 Remove duplicate release notes (0.27, 0.27.1, 0.35) 6e00da316 Remove obsolete content/release-notes/ directory 00a6d8c02 Change en dash back to `--` in 0.38.2-relnotes 51b32dc00 Update archetypes.md d0e5c2307 Release 0.40.1 4538a6d5b releaser: Prepare repository for 0.41-DEV 91b391d70 releaser: Add release notes to /docs for release of 0.40.1 e0979d143 releaser: Bump versions for release of 0.40.1 7983967c2 Clean images fe3fdd77d Polish showcase for Flesland Flis e6dde3989 Showcase - Flesland Flis AS by Absoluttweb 73aa62290 Revive @spf13's special Hugo font add67b335 Release Hugo 0.40 c0a26e5a6 Merge branch 'temp40' beeabaaae releaser: Prepare repository for 0.41-DEV e67d5e985 releaser: Add release notes to /docs for release of 0.40 6cdd95273 releaser: Bump versions for release of 0.40 bee21fb9b Revive the other Hugo logos too 4f45e8fe1 Fix the link type attribute for RSS in examples 8c67dc89a Fix example in delimit doc e7f6c00d5 Revive the logo used on the forum 82b0cd26e Merge commit 'a215abf70e018f4bf40d6c09d8bd148d8684b33d' 119c8ca58 Merge commit 'd2ec1a06df8ab6b17ad05cb008d5701b40327d47' db4683bd2 Improve .Get docs 05260b886 .Get function: fix syntax signature git-subtree-dir: docs git-subtree-split: e161ea09d33e3199f4998e4d2e9068d5a850f042
114 lines
4.7 KiB
Markdown
114 lines
4.7 KiB
Markdown
---
|
||
title: Install and Use Themes
|
||
linktitle: Install and Use Themes
|
||
description: Install and use a theme from the Hugo theme showcase easily through the CLI.
|
||
date: 2017-02-01
|
||
publishdate: 2017-02-01
|
||
lastmod: 2017-02-01
|
||
categories: [themes]
|
||
keywords: [install, themes, source, organization, directories,usage]
|
||
menu:
|
||
docs:
|
||
parent: "themes"
|
||
weight: 10
|
||
weight: 10
|
||
sections_weight: 10
|
||
draft: false
|
||
aliases: [/themes/usage/,/themes/installing/]
|
||
toc: true
|
||
wip: true
|
||
---
|
||
|
||
{{% note "No Default Theme" %}}
|
||
Hugo currently doesn’t ship with a “default” theme. This decision is intentional. We leave it up to you to decide which theme best suits your Hugo project.
|
||
{{% /note %}}
|
||
|
||
## Assumptions
|
||
|
||
1. You have already [installed Hugo on your development machine][install].
|
||
2. You have git installed on your machine and you are familiar with basic git usage.
|
||
|
||
## Install Themes
|
||
|
||
{{< youtube L34JL_3Jkyc >}}
|
||
|
||
The community-contributed themes featured on [themes.gohugo.io](//themes.gohugo.io/) are hosted in a [centralized GitHub repository][themesrepo]. The Hugo Themes Repo at <https://github.com/gohugoio/hugoThemes> is really a meta repository that contains pointers to a set of contributed themes.
|
||
|
||
{{% warning "Get `git` First" %}}
|
||
Without [Git](https://git-scm.com/) installed on your computer, none of the following theme instructions will work. Git tutorials are beyond the scope of the Hugo docs, but [GitHub](https://try.github.io/) and [codecademy](https://www.codecademy.com/learn/learn-git) offer free, interactive courses for beginners.
|
||
{{% /warning %}}
|
||
|
||
### Install All Themes
|
||
|
||
You can install *all* available Hugo themes by cloning the entire [Hugo Theme repository on GitHub][themesrepo] from within your working directory. Depending on your internet connection the download of all themes might take a while.
|
||
|
||
```
|
||
git clone --depth 1 --recursive https://github.com/gohugoio/hugoThemes.git themes
|
||
```
|
||
|
||
Before you use a theme, remove the .git folder in that theme's root folder. Otherwise, this will cause problem if you deploy using Git.
|
||
|
||
### Install a Single Theme
|
||
|
||
Change into the `themes` directory and download a theme by replacing `URL_TO_THEME` with the URL of the theme repository:
|
||
|
||
```
|
||
cd themes
|
||
git clone URL_TO_THEME
|
||
```
|
||
|
||
The following example shows how to use the "Hyde" theme, which has its source hosted at <https://github.com/spf13/hyde>:
|
||
|
||
{{< code file="clone-theme.sh" >}}
|
||
cd themes
|
||
git clone https://github.com/spf13/hyde
|
||
{{< /code >}}
|
||
|
||
Alternatively, you can download the theme as a `.zip` file, unzip the theme contents, and then move the unzipped source into your `themes` directory.
|
||
|
||
{{% note "Read the `README`" %}}
|
||
Always review the `README.md` file that is shipped with a theme. Often, these files contain further instructions required for theme setup; e.g., copying values from an example configuration file.
|
||
{{% /note %}}
|
||
|
||
## Theme Placement
|
||
|
||
Please make certain you have installed the themes you want to use in the
|
||
`/themes` directory. This is the default directory used by Hugo. Hugo comes with the ability to change the themes directory via the [`themesDir` variable in your site configuration][config], but this is not recommended.
|
||
|
||
## Use Themes
|
||
|
||
Hugo applies the decided theme first and then applies anything that is in the local directory. This allows for easier customization while retaining compatibility with the upstream version of the theme. To learn more, go to [customizing themes][customizethemes].
|
||
|
||
### Command Line
|
||
|
||
There are two different approaches to using a theme with your Hugo website: via the Hugo CLI or as part of your [site configuration file][config].
|
||
|
||
To change a theme via the Hugo CLI, you can pass the `-t` [flag][] when building your site:
|
||
|
||
```
|
||
hugo -t themename
|
||
```
|
||
|
||
Likely, you will want to add the theme when running the Hugo local server, especially if you are going to [customize the theme][customizethemes]:
|
||
|
||
```
|
||
hugo server -t themename
|
||
```
|
||
|
||
### `config` File
|
||
|
||
If you've already decided on the theme for your site and do not want to fiddle with the command line, you can add the theme directly to your [site configuration file][config]:
|
||
|
||
```
|
||
theme: themename
|
||
```
|
||
|
||
{{% note "A Note on `themename`" %}}
|
||
The `themename` in the above examples must match the name of the specific theme directory inside `/themes`; i.e., the directory name (likely lowercase and urlized) rather than the name of the theme displayed in the [Themes Showcase site](http://themes.gohugo.io).
|
||
{{% /note %}}
|
||
|
||
[customizethemes]: /themes/customizing/
|
||
[flag]: /getting-started/usage/ "See the full list of flags in Hugo's basic usage."
|
||
[install]: /getting-started/installing/
|
||
[config]: /getting-started/configuration/ "Learn how to customize your Hugo website configuration file in yaml, toml, or json."
|
||
[themesrepo]: https://github.com/gohugoio/hugoThemes
|