Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shinyypig/git-blog
A blog server written in go, and use git to manage posts.
https://github.com/shinyypig/git-blog
blog git go
Last synced: about 2 months ago
JSON representation
A blog server written in go, and use git to manage posts.
- Host: GitHub
- URL: https://github.com/shinyypig/git-blog
- Owner: shinyypig
- License: mit
- Created: 2023-06-12T13:16:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-16T02:24:24.000Z (10 months ago)
- Last Synced: 2025-01-01T16:02:12.671Z (about 2 months ago)
- Topics: blog, git, go
- Language: Go
- Homepage:
- Size: 233 KB
- Stars: 12
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Git Blog
Git Blog is a lightweight blog system based on Git and Markdown.
Features:
- Lightweight, no database required, cost about 10MB memory.
- Git based, you can use git to manage your blog.
- Markdown only, you can write your blog in Markdown.
- Repository compatible , a repository can be used as a blog.
- LaTeX support, you can write LaTeX in Markdown.
- Light/Dark theme, switch between light and dark theme automatically.
- Highly customizable, you can customize the theme and the template as you want.
Vist my website: [https://shinyypig.top](https://shinyypig.top) to see the demo.
## Installation
Clone this repository to your server:
```bash
git clone https://github.com/shinyypig/git-blog.git && cd git-blog
```
If you are familiar with linux, you can download [go](https://go.dev/doc/install) and build `gitblog` yourself:
```bash
go build
```
Or you can use the `build.sh` script to build it (only tested in debain):
```bash
sh build.sh
```
If success, you will get a `gitblog` executable file in the folder. Then you can run `init.sh` to generate the default configuration, template, and style files, and install the gitblog service:
```bash
sh init.sh
```
You may be asked to input a git url for the default extras repository, you can leave it blank if you want to use the default extras repository, which is [git-blog-extras](https://github.com/shinyypig/git-blog-extras).
Use the following command to play with the service:
```bash
systemctl start gitblog
systemctl stop gitblog
systemctl restart gitblog
systemctl status gitblog
```
If you want it to start automatically when the system starts, you can use the following command:
```bash
systemctl enable gitblog
```
## Update
You can simply cd to the git-blog folder and run the following command to update git-blog:
```bash
sh update.sh
```
It will pull the latest version from github, build the executable file, and restart the service.
## Usage
Git Blog serves as a git server, in which every post is a git repository, so you can use git to manage your post.
You can use the following command to download a post:
```bash
git clone http://yourdomain.com/yourpost.git
```
If it does not exist, then the server will create a new post for you.
You can modify the post in your local machine, and use `git push` to push it to the server.
Note that Git Blog will render the `README.md` file in the repository as the post, hence, your repositories on other git servers are also compatible with Git Blog. Simply push your repositories to the server, and it will be rendered as a post.
For more information, visit the **welcome** page after you run the server.
## Things to do
- Add support for mobile devices.
- Maybe a web editor?