Git Product home page Git Product logo

hugo-cookbook's Introduction

Cookbook Theme

Demo Site

About

Cookbook is a theme for hugo that stores all of your recipes and displays them in a viewable format on desktop and mobile.

Developed with Bulma CSS and UmbrellaJS (as well as fuse.js for search).

Cookbook Homepage

Features

  • Search all your recipes.
  • Display cooking/cooling time, calories, servings, and prep time.
  • Tag your recipes, browse by tags.
  • Break your ingredients into subheadings.
  • Print view.

Planned

  • 404 page.
  • More customizable print options, smaller font size for printing.
  • Any other layout tweaks/feature requests.

Install

First create your site: hugo new site <site_name>

Then move into the directory: cd <site_name>

You can install using hugo's recommended theme install method while in your hugo site directory:

git init

git submodule add https://github.com/deranjer/hugo-cookbook.git themes/cookbook

OR

You can download the latest release, or the the current master as a zip, then extract the zip file into the themes directory.

Copy Site Config

Then you can copy the config.toml from exampleSite to the root of your hugo directory, and modify that for your instance.

Setup Default Template

Since hugo-cookbook is a single purpose theme, you need to override your default archetype so that all content created is of recipe type.

To override the default template, copy the default.md from themes\archetypes\default.md to archetypes and overwrite the current default.md in that directory.

This will ensure that any new content you create will be of type recipe.

First Recipe

Simply run hugo new recipe_name.md to create your new recipe in the content folder. Modify the markdown file as required for your new recipe.

hugo serve to view the site.

Recipe Views of the Site

Ramen Recipe

Directions View

Direction View

hugo-cookbook's People

Contributors

deranjer avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

hugo-cookbook's Issues

Printing route not working

Hi
I set up a hugo site with your template as described within your README.md

Thanks for your great work. Unfortunately, the printing doesn't work, I get always a I'm sorry, your recipe is in another castle... error page. Must something special be in the config.toml file?

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.