52 lines
3.4 KiB
Markdown
52 lines
3.4 KiB
Markdown
# GoChowdown
|
|
|
|
A theme for [Hugo](https://gohugo.io/) based on the [Chowdown](https://github.com/clarklab/chowdown) theme for Jekyll
|
|
|
|
<p align="center">
|
|
<img src="https://raw.githubusercontent.com/seanlane/gochowdown/master/images/screenshot.png" />
|
|
</p>
|
|
|
|
## Quick Start
|
|
|
|
0. Install Hugo with your favorite package manager, or follow their [Installation Guide](https://gohugo.io/getting-started/installing/)
|
|
- Note that the _extended_ version of Hugo is required since this theme needs SCSS support. At the time of writing, this is the version found by installing via [HomeBrew](https://github.com/Homebrew/homebrew-core/blob/master/Formula/hugo.rb) and the [Arch User Repository](https://www.archlinux.org/packages/community/x86_64/hugo/). If that isn't the case for your package manager, then install using `$ go install --tags extended` as documented in the Hugo Install Docs.
|
|
1. Add the repository into your Hugo Project repository as a submodule, `git submodule add https://github.com/seanlane/gochowdown.git themes/gochowdown`.
|
|
2. Configure your `config.toml` or `config.yaml`. Default language is English. [Read this section](#change-the-default-language) to modify the default language.
|
|
3. Build your site with `hugo serve` and see the result at `http://localhost:1313/`.
|
|
|
|
## Using this theme
|
|
|
|
Similarly to how the original Chowdown theme for Jekyll was organized, this theme adds two sections, recipes and components. The primary section you'll want to use is the recipes, as they form the panel listing on the front page, as well as most of the content. The components section is for recipes that form subcomponents of a recipe, allowing for a recipe to call on several components, and different recipes to reuse the same component, if desired.
|
|
|
|
Note that this is a work in progress, so things may be broken or change in the future. Feel free to contribute or offer suggestions.
|
|
|
|
### Add a new recipe draft
|
|
|
|
1. Navigate to the root directory of your website folder within a terminal
|
|
2. Type `hugo new --kind recipe-bundle recipes/name-of-your-new-recipe-here`, replacing `name-of-your-new-recipe-here` with the name of your recipe
|
|
- Note that the default template (archetype in Hugo vernacular) will replace the hypens in the provided name with spaces as the title and capitalize the first letter of each word. For example, if I were to enter the command `hugo new --kind recipe-bundle recipes/hot-dog`, I would find a new folder at `content/recipes/hot-dog`, and the title within the `index.md` file in that folder would be `Hot Dog`.
|
|
|
|
### Add a new recipe with components
|
|
|
|
Similar to above, but instead of adding the recipes to the `content/recipes` directory, add the individual components to the `content/components` directory. Then add a new recipe as you normally would, and replace the instructions list with a components list, using the title (aka name) of the recipe, and modify the directions section as needed.
|
|
|
|
### Change the default language
|
|
|
|
You can change GoChowdown default language in your Hugo configuration. This will translate all text built into the theme. Currently supported languages are: `en` (default), `de`, `fr`.
|
|
|
|
The following is a `config.toml` example for using `fr` as the default language:
|
|
|
|
```
|
|
defaultContentLanguage = "fr"
|
|
|
|
[languages]
|
|
[languages.fr]
|
|
weight = 1
|
|
title = "Mon titre en Français"
|
|
```
|
|
|
|
## License
|
|
|
|
Coder is licensed under the [MIT license](https://github.com/seanlane/gochowdown/blob/master/LICENSE.md).
|
|
|