mirror of
https://github.com/tiennm99/hugoDocs.git
synced 2026-10-13 14:16:06 +00:00
Add content to contribute themes page from them GH readme
This commit is contained in:
1 parent
d5146d6831
commit
fcb147cb08
1 file changed
+104
@@ -15,4 +15,108 @@ needsreview: true
|
|||||||
notesforauthors:
|
notesforauthors:
|
||||||
---
|
---
|
||||||
|
|
||||||
|
# Hugo themes
|
||||||
|
|
||||||
|
A collection of all themes that were created by the Hugo community. See a complete listing of all of these themes along with screenshots and demos at [themes.gohugo.io](http://themes.gohugo.io/). Every theme in this list will automatically be added to the theme site. Theme updates aren't scheduled but usually happen at least once a week.
|
||||||
|
|
||||||
|
## Build script
|
||||||
|
|
||||||
|
For the curious,
|
||||||
|
[here's how](https://github.com/spf13/hugoThemeSiteScript/blob/master/generateThemeSite.sh)
|
||||||
|
this automatic adding is accomplished.
|
||||||
|
|
||||||
|
# Installation
|
||||||
|
|
||||||
|
## Installing all themes
|
||||||
|
|
||||||
|
If you would like to install all of the available Hugo themes, simply clone the entire repository from within your working directory with this command:
|
||||||
|
|
||||||
|
git clone --depth 1 --recursive https://github.com/spf13/hugoThemes.git themes
|
||||||
|
|
||||||
|
## Installing a single theme
|
||||||
|
|
||||||
|
<pre><code>cd themes
|
||||||
|
git clone <em>URL_TO_THEME</em>
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
|
# Adding a theme to the list
|
||||||
|
|
||||||
|
* Create your theme using <code>hugo new theme <em>THEMENAME</em></code>;
|
||||||
|
* Test your theme against https://github.com/spf13/HugoBasicExample;
|
||||||
|
* Add a `theme.toml` file to the root of the theme and add some metadata about the theme;
|
||||||
|
* Add a descriptive `README.md` to the root of the theme;
|
||||||
|
* Add `/images/screenshot.png` and `/images/tn.png` (see below);
|
||||||
|
* Open up a new Issue with a link to the theme's repository on GitHub.
|
||||||
|
|
||||||
|
If your theme doesn't fit into the `Hugo Basic Example` site, we encourage theme authors to supply a self-contained Hugo site in `/exampleSite`.
|
||||||
|
|
||||||
|
**NOTE:** The folder name here is important, as this folder will be picked up and used by the script that generates the Hugo Theme Site. It mirrors the root directory of a Hugo website and allows you to add custom content, assets and a config file with preset values.
|
||||||
|
|
||||||
|
See [Artist theme's exampleSite](https://github.com/digitalcraftsman/hugo-artists-theme/tree/master/exampleSite) for a good example. And please make the site's content as neutral as possible.
|
||||||
|
|
||||||
|
Each theme needs:
|
||||||
|
|
||||||
|
1. To be added to the hugoThemes repo;
|
||||||
|
1. To have the right fields in `theme.toml`;
|
||||||
|
1. To have the right images; and
|
||||||
|
1. A good README.
|
||||||
|
|
||||||
|
## theme.toml
|
||||||
|
|
||||||
|
This file contains metadata about the theme and its creator. The following fields are required:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
name = "Hyde"
|
||||||
|
license = "MIT"
|
||||||
|
licenselink = "https://github.com/spf13/hyde/blob/master/LICENSE.md"
|
||||||
|
description = "An elegant open source and mobile first theme"
|
||||||
|
homepage = "http://siteforthistheme.com/"
|
||||||
|
tags = ["blog", "company"]
|
||||||
|
features = ["blog", ]
|
||||||
|
min_version = 0.13
|
||||||
|
|
||||||
|
[author]
|
||||||
|
name = "spf13"
|
||||||
|
homepage = "http://spf13.com/"
|
||||||
|
|
||||||
|
# If porting an existing theme
|
||||||
|
[original]
|
||||||
|
author = "mdo"
|
||||||
|
homepage = "http://hyde.getpoole.com/"
|
||||||
|
repo = "https://www.github.com/mdo/hyde"
|
||||||
|
```
|
||||||
|
|
||||||
|
> **Notes:**
|
||||||
|
>
|
||||||
|
> 1. This is different from the file created by `hugo new theme` in the old v0.12.
|
||||||
|
> The current Hugo v0.13 does create the same template with the new fields
|
||||||
|
> except `min_version` that was added in 0.14-DEV.
|
||||||
|
>
|
||||||
|
> 2. Only `theme.toml` is accepted, not `theme.yaml` or not `theme.json`.
|
||||||
|
|
||||||
|
|
||||||
|
## Media
|
||||||
|
|
||||||
|
Screenshots are used as preview in the list. Make sure that they have the right dimensions:
|
||||||
|
|
||||||
|
* Thumbnail should be 900×600 in pixels
|
||||||
|
* Screenshot should be 1500×1000 in pixels
|
||||||
|
* Media must be located in:
|
||||||
|
* <code><em>[ThemeDir]</em>/images/screenshot.png</code>
|
||||||
|
* <code><em>[ThemeDir]</em>/images/tn.png</code>
|
||||||
|
|
||||||
|
Additional media may be provided in that same directory.
|
||||||
|
|
||||||
|
## README.md
|
||||||
|
|
||||||
|
Your theme's README file
|
||||||
|
(which should be written in Markdown and called `README.md`)
|
||||||
|
serves a double purpose.
|
||||||
|
This is because its content will appear in two places—i.e., it will appear:
|
||||||
|
|
||||||
|
1. On your theme's details page at [themes.gohugo.io](http://themes.gohugo.io/); and
|
||||||
|
1. At GitHub (as usual), on your theme's regular main page.
|
||||||
|
|
||||||
|
**Note:** If you add screenshots to the README please make use of absolute file paths instead of relative ones like `/images/screenshot.png`. Relative paths work great on GitHub but they don't correspond to the directory structure of [themes.gohugo.io](http://themes.gohugo.io/). Therefore, browsers will not be able to display screenshots on the theme site under the given (relative) path.
|
||||||
|
|
||||||
|
|
||||||
Reference in new issue
Block a user