Code Monkey home page Code Monkey logo

hugothemes's Introduction

hugoThemes

All Themes Hugo

See a complete listing of all of these themes along with screenshots and demos at http://themes.gohugo.io (coming soon).

Every theme in this list will automatically be added to the theme site.

Installing Themes

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.

git clone --recursive https://github.com/spf13/hugoThemes.git themes

Installing a single theme

mkdir themes
cd themes
git clone URL_TO_THEME

Adding a theme to the list

  • Create your theme using hugo new theme THEMENAME
  • Test your theme against https://github.com/spf13/HugoBasicExample
  • Add a theme.toml file to the root of the theme
  • Add a README.md to the root of the theme
  • Add /images/snapshot.png and /images/tn.png
  • Send a PR with the git submodule addition

Each theme needs:

  1. To be added to the themes repo
  2. The right fields in theme.toml
  3. The right images
  4. A good readme.

theme.toml

The following fields are required Notice: This is different from the file created by hugo new theme in v0.12

name = "Hyde"
license = "MIT"
licenselink = "http://github.com/spf13/hugo/.."
description = "An elegant open source and mobile first theme"
homepage = "http://siteforthistheme.com"
tags = ["blog", "company"]
features = ["blog", ]

[author]
    name = "spf13"
    homepage = "http://spf13.com"

# If Porting existing theme
[original]
    author =  "mdo"
    homepage = "http://andhyde.com"
    repo = "http://www.github.com/mdo/hyde"

Media

Thumbnail should be 900x600 Screenshot Should be 1500x1000

Media must be located in:

[ThemeDir]/images/screenshot.png [ThemeDir]/images/tn.png

Additional media may be provided in that same directory.

ReadMe

The readme serves double purposes. It is used on github as the content for the main page. It also will become the content on the detailed theme view page for themes.gohugo.io. It should be markdown and called README.md.

hugothemes's People

Contributors

crakjie avatar spf13 avatar tmaiaroto avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.