Showcase is a minimal, single page theme for Hugo
Features:
- Auto-generated menu
- Responsive content
- Filtering content
- Social links
- Custom menu
Run from the root of your Hugo site:
git clone https://github.com/apvarun/showcase-hugo-theme.git themes/showcase
Alternatively, you can include this repository as a git submodule. This makes it easier to update this theme if you have your Hugo site in git as well:
git submodule add https://github.com/apvarun/showcase-hugo-theme.git themes/showcase
Showcase theme ships with an fully configured example site. For a quick preview:
cd themes/showcase/exampleSite/
hugo serve --themesDir ../..
Then visit http://localhost:1313/
in your browser to view the example site.
The following explains how to add content to your Hugo site. You can find sample content in the exampleSite/
folder.
.
├── ...
├── projects # Section Name
│ ├── project1 # Project 1
│ ├── project2 # Project 2
│ └── _index # (optional) Customize section name &
│ # default image for section contents
└── ...
From exampleSite/
, copy config.toml
to the root folder of your Hugo site and change the fields as you like. Helpful comments are provided.
Menu in Showcase theme is auto-generated from the sections inside your content folder.
You can also add a custom menu item using the config.toml
and disable auto-generated sections if not required. Refer config in exampleSite
Set googleAnalytics
in config.toml
to activate Hugo's internal Google Analytics template.
If you have a question, please open an issue for help and to help those who come after you. The more information you can provide, the better!
Contributions are welcome. For major changes, please open an issue first to discuss what you would like to change.
Licensed under MIT