my blog
Quick Installation
sudo dnf remove ruby
sudo dnf install rbenv ruby-build
rbenv install 3.0.1
rbenv global 3.0.1
# add this to your ~/.bashrc
exec PATH="$HOME/.rbenv/bin:$PATH"
eval "$(rbenv init -)"
#############################################
git clone https://github.com/nrmancuso/blog.git
cd blog
./bin/bootstrap
bundle install
Running Locally
./bin/start
- development server will start at http://127.0.0.1:4000
Deployment
Just push to main branch, and github actions will take care of the rest.
Customizing
You can edit _config.yml
file to customize your blog. You can change things such as the name of the blog, the author, the appearance of the theme (light, dark or auto), how dates are formatted, etc. Customizable fields should be straightforward to understand. Still, _config.yml
contains some comments to help you understand what each field does.
For further customization (e.g. layout, CSS) see the official Jekyll's documentation on customizing gem-based themes.
Customize the menu
In order to add/edit/delete entries in the home page, you can copy the home.yml
file inside _data
folder. Through that file you can define the structure of the menu and add data for navbar, footer, portfolio or simply remove all of that and use simple blog layout. Take a look at the default configuration to get an idea of how it works and read on for a more comprehensive explaination.
The home.yml
file accepts the following fields:
- Vertical list
entries
define a new unordered list that will contain menu entries- each entry is marked by a
-
at the beginning of the line - each entry has the following attributes:
title
, which defines the text to render for that menu entryurl
, which can either be a URL orfalse
. If it isfalse
, the entry will be rendered as plain text; otherwise the entry will be rendered as a link pointing to the specified URL. Note that the URL can either be relative or absolute.post_list
, which can betrue
orfalse
. If it is true, the entry will have all posts in the site as subentries. This is used to render your post list.entries
, yes, you can have entries inside entries. In this way you can create nested sublists!
- Card list - cards are used to showcase portfolio projects. Please see
project_entries
in_data/home.yml
file
- each entry is marked by a
-
at the beginning of the line - each entry has the following attributes:
title
defines the header of the carddesc
is the body of the cardurl
is a relative or absolute link which this card can point to.highlight
in case you want to highlight something, keep the text short though
- Horizontal list - moonwalk uses horizontal lists to create navbar and footer. Please see
navbar_entries
andfooter_entries
indata/home.yml
file
- each entry is marked by a
-
at the beginning of the line - each entry has the following attributes:
title
defines the header of the cardurl
is a relative or absolute link which this card can point to.
Pro tips
- Moonwalk has 3 in-built layouts:
- post - for content
- blog - for listing blog posts
- home - for landing page
you can change your
index.md
file to use either home or blog layout.
- It is extremely easy to tweak the color scheme.
- for light mode, customize these css variables
html {
--bg: #fff;
--bg-secondary: #f3f4f6;
--headings: #1e293b;
--text: #374151;
--text-secondary: #6b7280;
--links: #6366f1;
--highlight: #ffecb2; // light yellow
--code-text: #9d174d;
}
- for dark mode customize these css variables
@mixin dark-appearance {
html, body {
--headings: #74c0fc;
--links: #91a7ff;
--highlight: #41c7c7;
--bg: #1f242a;
--bg-secondary: #323945;
--text: #adb5bd;
--text-secondary: #9ca3af;
--code-text: #91a7ff;
};
}
Development
To set up your environment to develop this theme, run bundle install
.
Your theme is setup just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve
and open your browser at http://localhost:4000
. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
When your theme is released, only the files in _layouts
, _includes
, _sass
and assets
tracked with Git will be bundled.
To add a custom directory to your theme-gem, please edit the regexp in moonwalk.gemspec
accordingly.
Acknowledgement
This theme's original base is no style please! theme created by Riccardo Graziosi - many thanks to him for creating a wonderful theme with nearly no css.
License
The theme is available as open source under the terms of the MIT License.