Welcome to mirror list, hosted at ThFree Co, Russian Federation.

README.md - github.com/spaghettiwews/hugonews.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 1c0e9d395dc71d34e0e1aeac0ca6a041dcec26b8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# hugonews 
*a hugo theme for a personal bookmarking website*

**hugonews** is a [Hugo](https://gohugo.io) theme that I primarily use for my absurd bookmarking website - https://bookmarks.wews.co. Its aesthetic was inspired by that of [Hacker News](https://news.ycombinator.com)

## Getting Started

### Prerequisites
1. Hugo
1. Git

### Usage

1. Create a new Hugo website 
    ```bash
    hugo new site <sitename>
    ```

2. Initialise the website source folder as a Git repository
    ```bash
    cd <sitename> && git init
    ```

3. Add the hugonews theme as a submodule to your website repo
    ```bash
    git submodule add https://github.com/spaghettiwews/hugonews.git themes/hugonews
    ```

4. Set your site theme to hugonews by editing `config.toml` and adding the following line **`theme = "hugonews"`**
    ```markdown
    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
    ```bash
    hugo new items/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/items/`
    ```markdown
    ---
    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](https://gohugo.io/hosting-and-deployment/)).