把 GitHub 仓库变成博客：我开源了 Marklog

一个极简的、基于 GitHub 的博客平台，写 Markdown，存在 Git，瞬间发布。

Jask
Jask Independent researcher & builder独立研究者与开发者

2 min read分钟读完 · marklog

#博客平台#Github

Marklog 让你把任何 GitHub 仓库变成一个漂亮、快速、响应式的博客。不需要数据库，不需要 CMS——只需要你、你的文本编辑器，和你的 Git 仓库。

它能做什么

  • GitHub 集成：直接从你的仓库读取 Markdown 文件
  • 零配置：开箱即用，默认设置就很舒服
  • 多主题：内置 Light、Dark、Ghibli、Pixel三款主题
  • 响应式：手机、平板、电脑阅读体验都完美
  • Frontmatter：支持标题、日期、描述、标签等元数据
  • 快：基于 Next.js 14 App Router，性能拉满

iPhone示例图片

怎么使用

方法一：用你已有的仓库

  1. 访问 marklog.xyz
  2. 输入你的 用户名/仓库名
  3. 访问

方法二：建一个专门的博客仓库

  1. 在 GitHub 上新建一个仓库（比如 my-blog）
  2. 在根目录创建 blog 文件夹
  3. 在 blog 文件夹里写 Markdown 文件

比如 hello-world.md：

---
title: Hello World
date: 2024-03-01
description: 我在 Marklog 的第一篇文章
---

# 欢迎

这是我的第一篇文章！
  1. 访问 marklog.xyz/你的用户名/my-blog 就能看到

自定义配置

在仓库根目录加一个 blog.config.yaml 文件：

title: 我的博客
description: 随便写写
theme: ghibli # light, dark, ghibli, pixel
show_toc: true
socials:
  twitter: https://twitter.com/username
  github: https://github.com/username
analytics:
  google: "G-XXXXXXXXXX"

示例地址

我为什么会做这个

我一直想要一个「属于开发者」的博客平台。用自己熟悉的编辑器写，用 Git 做版本控制，不用学 WordPress，不用配服务器。

后来发现，GitHub 仓库本身就是最好的内容存储——为什么不直接用呢？

Marklog 就这么诞生了。