murarisumit / kbs-source

hugonews

a hugo theme for a personal bookmarking website

hugonews is a Hugo theme that is used for putting my knowledge base, its aesthetic was inspired by that of Hacker News

Getting Started

Prerequisites

1. Hugo
2. Git

Usage

1. Create a new Hugo website

   hugo new site <sitename>

2. Initialise the website source folder as a Git repository

   cd <sitename> && git init

3. Add the hugonews theme as a submodule to your website repo

   git submodule add https://github.com/murarisumit/hugonews.git themes/hugonews

4. Set your site theme to hugonews by editing config.toml and adding the following line theme = "hugonews"

   baseURL = "http://example.org/"
   languageCode = "en-us"
   title = "My New Hugo Site"
   theme = "hugonews"

5. Now, from the root of your website, create a bookmark item using the hugo CLI

   hugo new tils/dark-mode-website-css.md
   hugo new bookmarks/dark-mode-website-css.md
   hugo new snippets/dark-mode-website-css.md

6. Edit the newly created file to add the necessary metadata. The file will be in your content directory in /content/tils/

   ---
   title: "Dark mode in a website with CSS"
   date: 2019-10-09T12:13:32+02:00
   itemurl: "https://tombrow.com/dark-mode-website-css"
   sites: "tombrow.com"
   tags: ["frontend", "css", "dark mode"]
   draft: false
   ---

7. Repeat steps 5 and 6 to add new/more bookmarks.

8. Build the site using hugo and deploy the /public folder following any one of the guides that can be found in the Hugo documentation (Hosting & Deployment).