Skip to content

Commit fa2368e

Browse files
Create README.md
1 parent 64fa30f commit fa2368e

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Blog-Template
2+
3+
A static, privacy-focused blog inspired by [elementary's own blog](https://github.com/elementary/blog-template?tab=readme-ov-file).
4+
5+
## Goals
6+
7+
This is the third iteration of a blog that was originally written in Vue and then rewritten in Jekyll twice.
8+
9+
- **Something that feels like home** – Reflecting the design language we have come to love in Beaver.
10+
- **Little to no JavaScript** – The less, the better. We tried to use as little JavaScript as possible.
11+
- **Hassle-free for the reader** – Easy to navigate and content-focused.
12+
- **RSS feed support** – For better cross-posting and reading experience.
13+
- **Reusable and scalable** – Something you can use for your project.
14+
- **Easy to maintain** – Writing articles is already time-consuming; why make it worse?
15+
- **Easy to deploy** – Compatible with GitHub Pages.
16+
17+
## Repositories
18+
19+
The blog is split into two repositories:
20+
21+
1. [**Beaver-Blog**](https://github.com/Beaver-Notes/Beaver-Blog)
22+
2. [**Beaver-Blog-Template**](https://github.com/Beaver-Notes/Beaver-Blog-Template)
23+
24+
The template follows Beaver's philosophy of making everything open source in a way that you can use in your own projects. The main repository holds a copy of the template plus the actual posts themselves and is set up with GitHub Pages.
25+
26+
## 💖 Contribution
27+
28+
If you want to contribute to Beaver's own blog, check out our [docs](https://docs.beavernotes.com/beaver%20notes%20(dev)/2025/01/06/Contribute-to-blog.html). If you use this template in your project and want to improve it, feel free to open a pull request against this repo. Donations are, of course, always welcome.

0 commit comments

Comments
 (0)