You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
67 lines
2.0 KiB
67 lines
2.0 KiB
# Cookbook Theme
|
|
|
|
[Demo Site](https://wonderful-raman-ea1990.netlify.app)
|
|
|
|
## 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).
|
|
|
|
|
|
|
|
## Features
|
|
|
|
- [x] Search all your recipes.
|
|
- [x] Display cooking/cooling time, calories, servings, and prep time.
|
|
- [x] Tag your recipes, browse by tags.
|
|
- [x] Break your ingredients into subheadings.
|
|
- [x] 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
|
|
|
|
|
|
|
|
## Directions View
|
|
|
|
 |