https://github.com/rafalkaron/r-hugo-theme

A simple Hugo theme suitable for a portfolio, documentation library, or blog.
https://github.com/rafalkaron/r-hugo-theme

blog documentation hugo portfolio ssg theme website

Last synced: 3 months ago
JSON representation

A simple Hugo theme suitable for a portfolio, documentation library, or blog.

• Host: GitHub
• URL: https://github.com/rafalkaron/r-hugo-theme
• Owner: rafalkaron
• License: mit
• Created: 2022-05-14T08:13:19.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-17T12:34:15.000Z (8 months ago)
• Last Synced: 2024-05-17T13:50:27.027Z (8 months ago)
• Topics: blog, documentation, hugo, portfolio, ssg, theme, website
• Language: CSS
• Homepage: https://rafalkaron.github.io/r-hugo-theme-demo
• Size: 6.28 MB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# r-hugo-theme

A simple Hugo theme suitable for a portfolio, documentation library, or blog. See [r-hugo-theme-demo](https://rafalkaron.github.io/r-hugo-theme-demo).  

  



## Key features

* Responsive layout for desktops, tablets, mobile, and print

* A switch that controls light and dark modes

* Extensive, automatically generated site navigation that includes:

  * Section navigation (in this section)

  * Page navigation (on this page)

  * Breadcrumbs

  * Links to next and previous pages

  * Related links based on keywords

* Easily customizable contact info in the footer

* Blogging capabilities:

  * Categories

  * Tags

  * Estimated reading time

## Quick start

Set up a simple website that uses r-hug-theme with sample content.

### Prerequisites

* [Install Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)

* [Install Hugo](https://gohugo.io/getting-started/quick-start/#step-1-install-hugo)

### Procedure

3. In the terminal, create a new site by entering `hugo new site {site_name}`  

**Where:** `{site_name}` is the name of the site that you want to create.

4. Enter the Hugo site directory by entering `cd {site_name}`

5. Initialize a Git repository by entering `git init`

6. Add the theme by entering `git submodule add https://rafalkaron.github.io/r-hugo-theme`

7. Move the files and folders from the `example-site` or `example-site-multilingual` directory into the root folder of your site.

8. Run a local Hugo webserver by entering `hugo server`

### Postrequisites

* Preview your website by opening [http://localhost:1313/](http://localhost:1313/)

## Theme customization

You can further customize the site by editing the `config.yaml` file. For more information, see the [Hugo documentation](https://gohugo.io/documentation/).