About
redgood
is a clean minimal javascript-less hugo theme for blogs.
Demo
This is the live demo.
Installation
If the site is not a git repo, it is necessary to first run git init
. Run the following command in the site root directory to add redgood
as a submodule:
git submodule add https://github.com/urjaacharya/redgood.git themes/redgood
Getting started
- Copy the contents of
config.toml
in the exampleSite folder to aconfig.toml
in the site root directory and update it as needed. - Copy all the contents from
exampleSite/content
to acontent
folder in the root directory. At the least, the foldersarchive
andpinnedPosts
need to be copied. - Run
hugo server
to begin developing.
Adding contents
The contents of your site should be in content
folder in the root directory. Each folder in the content
folder represent dfferent sections. The archive
and pinnedPosts
are special sections and are used by the theme for displaying all posts and pinned posts, respectively.
Additional content directories for more content sections can be added as required. When adding new folders, also create a new _index.md
file inside each folder and add relevant metadata in the front matter.
Refer to _index.md
for an example.
Pinned posts
The theme allows for showing a pinned post in the home page. If pinned post is not defined, then the most recent post will be shown instead. Posts that were pinned in the past will be shown in a dedicated section (/pinnedposts/
).
For pinning posts, add pinned = true
if using TOML
or pinned: true
if using YAML
in the front matter of the markdown file.
Here is an example of pinned content
for more information.
Contributing
For comments, questions, and bugs, create an issue in the github repo.