You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: index.md
+105-3Lines changed: 105 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,8 +3,110 @@ layout: default
3
3
title: Home
4
4
---
5
5
6
-
# Hello Nyx!
6
+
# jekyll-theme-nyx
7
7
8
-
This is a live demo of Nyx, a simple Jekyll theme.
8
+
Nyx is a dark mode based Jekyll theme focused on readability, clean typography, and simple blogging. It is designed to work out-of-the-box as a RubyGem-based theme while still being easy to customize via SCSS.
9
9
10
-
[link to demo post](/blog/2026/01/02/markdown-showcase.html)
10
+
---
11
+
12
+
## Installation
13
+
14
+
Add this line to your Jekyll site’s `Gemfile`:
15
+
16
+
```ruby
17
+
gem "jekyll-theme-nyx"
18
+
```
19
+
20
+
Then install the gem:
21
+
22
+
```sh
23
+
bundle install
24
+
```
25
+
26
+
Next, enable the theme in your _config.yml:
27
+
28
+
```yml
29
+
theme: jekyll-theme-nyx
30
+
```
31
+
32
+
Build or serve your site to verify everything works:
33
+
34
+
```sh
35
+
bundle exec jekyll serve
36
+
```
37
+
38
+
## Usage
39
+
40
+
This theme follows standard Jekyll conventions.
41
+
42
+
### Layouts
43
+
44
+
Nyx provides the following layouts:
45
+
46
+
-`default` – base layout
47
+
-`post` – blog post layout
48
+
49
+
You can select a layout per page or post:
50
+
51
+
```yml
52
+
layout: post
53
+
```
54
+
55
+
### Styling
56
+
57
+
All styles are written in SCSS and live under:
58
+
59
+
```
60
+
_sass/nyx/
61
+
```
62
+
63
+
The main entrypoint is:
64
+
65
+
```
66
+
assets/css/nyx.scss
67
+
```
68
+
69
+
If you want to override styles, you can:
70
+
71
+
- copy partials from `_sass/nyx/` into your own project
72
+
- or add custom styles after importing `nyx.scss`
73
+
74
+
### Includes
75
+
76
+
Reusable components live in `_includes/`, such as:
77
+
78
+
-`sidebar.html`
79
+
80
+
These can be overridden by copying them into your site’s `_includes/` directory.
81
+
82
+
## Development
83
+
84
+
To work on the theme locally:
85
+
86
+
```sh
87
+
bundle install
88
+
bundle exec jekyll serve
89
+
```
90
+
91
+
This repository includes a dummy Jekyll site for testing theme changes.
92
+
93
+
Useful tasks:
94
+
95
+
```sh
96
+
rake site # build the dummy site
97
+
rake build # build the gem
98
+
```
99
+
100
+
Built gems are placed in the pkg/ directory.
101
+
102
+
## Contributing
103
+
104
+
Bug reports and pull requests are welcome on GitHub at https://github.com/Slavetomints/jekyll-theme-nyx. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Slavetomints/jekyll-theme-nyx/blob/main/CODE_OF_CONDUCT.md).
105
+
106
+
## License
107
+
108
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
109
+
110
+
## Code of Conduct
111
+
112
+
Everyone interacting in the jekyll-theme-nyx project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Slavetomints/jekyll-theme-nyx/blob/main/CODE_OF_CONDUCT.md).
0 commit comments