Skip to content

Commit

Permalink
HowTo work with this site
Browse files Browse the repository at this point in the history
Signed-off-by: Joachim Wiberg <[email protected]>
  • Loading branch information
troglobit committed Jul 25, 2024
1 parent b2e8872 commit 76d419b
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
## Checkout

cd path/to/your/repos
git clone [email protected]:kernelkit/kernelkit.github.io.git blog
cd blog/
git submodule update --init

Make changes/additions on a separate branch:

git checkout -b my-changes

When you push it to GitHub you will get a question by GitHub.com if you
want to create a pull request. Do that and follow the instructions.

## Setup

This blog use [Jekyll][0] with the [Chirpy theme][1]. Jekyll is written
in Ruby, so you need a fairly modern system to write and preview posts.
Verified to work on Linux Mint 21.3, based on Ubuntu 22.04 LTS:

- [Install Jekyll](https://jekyllrb.com/docs/installation/)
- Run `bundle` from the blog directory to install all deps

## Blog

1. New blog posts go in `_posts/yyyy-mm-dd-brief-title.md`
2. Add front matter at the top of your post

---
title: Longer title of post
date: 2022-11-20 09:03:20 +0100
categories: [examples]
tags: [cli]
pin: false
---

3. [Add content ...](https://chirpy.cotes.page/posts/write-a-new-post/)
4. Use relevant tags and categories, check first!
5. Preview

jekyll serve -lIw

[0]: https://jekyllrb.com/
[1]: https://chirpy.cotes.page/

0 comments on commit 76d419b

Please sign in to comment.