Skip to content

Commit 76d419b

Browse files
committed
HowTo work with this site
Signed-off-by: Joachim Wiberg <[email protected]>
1 parent b2e8872 commit 76d419b

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## Checkout
2+
3+
cd path/to/your/repos
4+
git clone [email protected]:kernelkit/kernelkit.github.io.git blog
5+
cd blog/
6+
git submodule update --init
7+
8+
Make changes/additions on a separate branch:
9+
10+
git checkout -b my-changes
11+
12+
When you push it to GitHub you will get a question by GitHub.com if you
13+
want to create a pull request. Do that and follow the instructions.
14+
15+
## Setup
16+
17+
This blog use [Jekyll][0] with the [Chirpy theme][1]. Jekyll is written
18+
in Ruby, so you need a fairly modern system to write and preview posts.
19+
Verified to work on Linux Mint 21.3, based on Ubuntu 22.04 LTS:
20+
21+
- [Install Jekyll](https://jekyllrb.com/docs/installation/)
22+
- Run `bundle` from the blog directory to install all deps
23+
24+
## Blog
25+
26+
1. New blog posts go in `_posts/yyyy-mm-dd-brief-title.md`
27+
2. Add front matter at the top of your post
28+
29+
---
30+
title: Longer title of post
31+
date: 2022-11-20 09:03:20 +0100
32+
categories: [examples]
33+
tags: [cli]
34+
pin: false
35+
---
36+
37+
3. [Add content ...](https://chirpy.cotes.page/posts/write-a-new-post/)
38+
4. Use relevant tags and categories, check first!
39+
5. Preview
40+
41+
jekyll serve -lIw
42+
43+
[0]: https://jekyllrb.com/
44+
[1]: https://chirpy.cotes.page/

0 commit comments

Comments
 (0)