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

README.md - github.com/LordMathis/hugo-theme-nix.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: d37b54195701ce0eaf001113d24251215f5ac094 (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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# Nix

Nix is a simple, minimal theme for Hugo

![Hugo Theme Nix](https://raw.githubusercontent.com/LordMathis/hugo-theme-nix/master/images/screenshot.png)

## Usage

Clone the repository to your hugo theme directory

```
mkdir themes
cd themes
git clone https://github.com/LordMathis/hugo-theme-nix
```

## Configuration

Add these parameters to your `config.toml`:

```
[params]
  Name = "your_name"
  HeaderUsername = "username"
  HeaderHostname = "hostname"
  About = "info_about_you"
  ProfilePicture = "profile_picture_url"
```

`HeaderUsername` and `HeaderHostname` will be displayed in navbar on left side in the format: `HeaderUsername@HeaderHostname ~ $`.  

Optionaly you can add any of these social networks to the \[params\] section.

```
  BitbucketID = "your_bitbucket_id"
  CodepenID = "your_codepen"
  CvURL = "your_cv_url"
  Email = "your_email"
  FacebookID = "your_facebook"
  GithubID = "your_github"
  GitlabId = "your_gitlab"
  GnuPGFingerprint = "your_gpg_fingerprint"
  GoogleAnalytics = "your_google_analytics_id"
  GoogleplusID = "your_googleplus"
  InstagramID = "your_instagram"
  LinkedInID = "your_linkedin"
  MastodonURL = "your_mastodon_profile"
  MediumID = "your_medium_id"
  Mobile = "+1-201-555-0123"
  PayPalMeID = "https://www.paypal.me/..."
  Phone = "+1-201-555-0123"
  RedditID = "your_reddit"
  SlackURL = "https://join.slack.com/..."
  SpotifyID = "your_spotify_id"
  SoundcloudID = "your_soundcloud_id"
  StackExchangeID = "your_stackexchange_id"
  StackOverflowID = "your_stackoverflow_id"
  TelegramID = "your_telegram"
  TwitterID = "your_twitter"
  TwitchID = "your_twitch_username"
  XingURL = "https://www.xing.com/profile/..."
  # For youtube, since there are multiple path urls please add everything after https://youtube.com/ in channel url
  YoutubeID = "c/your_youtube_id"
```

To add a menu item add `[[menu.header]]` item to `config.toml`. For example:

```
[menu]
  [[menu.header]]
    name = "posts"
    weight = 0
    url = "/posts"
```

To add a submenu item add `[[menu.header]]` item with a parent parameter to `config.toml`. For example:

```
[menu]
  [[menu.header]]
    identifier = "post"
    name = "posts"
    weight = 0
  [[menu.header]]
    parent = "post"
    name = "All Posts"
    url = "/posts"
  [[menu.header]]
    parent = "post"
    name = "categories"
    url = "/categories"
  [[menu.header]]
    parent = "post"
    name = "tags"
    url = "/tags"
```

To enable disqus comments add `disqusShortname` to your `config.toml`.

You can turn off disqus comments per page by adding `nocomments = true` to the front matter.

## License

Nix is licensed under the [MIT License](LICENSE.md)