简单方便的静态博客生成工具
- 没有分类信息;
- 也不区分页面和文章;
- 仅通过标签对文章进行归类;
- 可生成 RSS、Atom 和 Sitemap 等数据;
- 存档页按可以按月和年进行分类;
- 采用 Go 模板作为主题模板语法;
- 可在主题中指定代码高亮;
- 生成静态 TOC 数据;
macOS 和 linux 用户可以直接使用 brew 进行安装:
brew tap caixw/brew
brew install caixw/brew/blogit
常用平台也可以从 https://github.com/caixw/blogit/releases 下载,并将二进制文件放入 PATH
即可。
如果不存在你当前平台的二进制,可以自己编译:
git clone https://github.com/caixw/blogit.git
cd blogit
./build.sh
目前 docker 同时托管于 docker.io 和 ghcr.io,可通过以下方式获取相应在的容器:
docker pull docker.io/caixw/blogit:latest
docker pull ghcr.io/caixw/blogit:latest
blogit init dir
可以直接生成一个完整的博客系统。具体使用可参考 USAGE。
如果你的网站部署在 github 的话,可以直接使用 action 实现全程自动化编译上传代码。
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: checkout source
uses: actions/checkout@v2
with:
repository: owner/src
path: src/
- name: checkout dest
uses: actions/checkout@v2
with:
repository: owner/dest
path: dest/
persist-credentials: false # github-push-action@master 需要这个
fetch-depth: 0 # # github-push-action@master 需要这个
- name: build static site
uses: caixw/blogit@master
with:
src: src
dest: dest
- name: commit files
uses: EndBug/add-and-commit@v7
with:
author_name: github-actions
author_email: 41898282+github-actions[bot]@users.noreply.github.com
cwd: dest/
push: false
message: 'docs: add changes'
- name: push changes
uses: ad-m/github-push-action@master
with:
directory: dest/
github_token: ${{ secrets.GITHUB_TOKEN }} # 确保有相应的权限
branch: ${{ github.ref }}
secrets.GITHUB_TOKEN
关联的 PAT 需要有写入 owner/dest
指向的仓库的权限。
名称 | 类型 | 必填 | 默认值 | 描述 |
---|---|---|---|---|
src | string | true | src | 源文件的路径 |
dest | string | true | dest | 编译后的路径 |