https://github.com/zonemeen/gitpress
📝 Create a minimalist markdown blogging platform via github actions
https://github.com/zonemeen/gitpress
Last synced: 6 months ago
JSON representation
📝 Create a minimalist markdown blogging platform via github actions
- Host: GitHub
- URL: https://github.com/zonemeen/gitpress
- Owner: zonemeen
- License: mit
- Created: 2022-06-16T12:58:24.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-16T12:35:17.000Z (about 3 years ago)
- Last Synced: 2025-03-04T06:04:15.383Z (7 months ago)
- Language: CSS
- Homepage:
- Size: 1.01 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README-CN.md
- License: LICENSE
Awesome Lists containing this project
README
Gitpress
通过Github Actions创建一个简约的markdown博客平台
## 使用示例
- [代码库](https://github.com/zonemeen/zonemeen.github.io)
- [博客地址](https://zonemeen.github.io/)
- [English](./README.md)
首先访问模板仓库：[zonemeen.github.io](https://github.com/zonemeen/zonemeen.github.io)，然后点击此仓库右侧的 `Use this template`：
然后根据你的 `github username`，给仓库起名字: `yourname.github.io`：
底下是具体的配置。
## 配置博客
在GitHub上创建一个仓库（通过GitHub Pages部署，通常命名为yourname.github.io）来托管你的博客，其目录结构如下：
```shell
├── about.md
├── site.json
├── posts
├── better-javascript.md
├── Vue vs React.md
└── technique-in-typescript.md
└── static
├── resume.pdf
└── assets
└── me.jpg
```
### 关于页面
`about.md` 是包含关于页面内容的markdown文件。
### 站点配置
`site.json` 包含博客站点的配置，下面是JSON配置的例子：
```json
{
"title": "zonemeen",
"subtitle": "I'm a passionate, self-taught, career-changed front-end developer since 2021",
"owner": {
"name": "zonemeen",
"email": "miqilin18@gmail.com"
},
"social": [
{
"type": "Github",
"url": "https://github.com/zonemeen"
},
{
"type": "Twitter",
"url": "https://twitter.com/zonemeen"
}
],
"seo": {
"title": "zonemeen's blog",
"description": "A front-end engineer's article sharing",
"author": "zonemeen",
"keywords": [
"blog",
"javascript",
"typescript",
"passionate",
"self-taught",
"career-changed",
"front-end developer"
]
},
"cname": "zonemeen.github.io"
}
```
`cname`是你的个人域名（如果适用的话）。
### 博客文章
`posts/` 是包含你所有markdown格式的博客文章的目录，它支持在每篇博文的顶部有以下的头字段（front-matter）：
```shell
---
title: Your first blog on GitHub Pages
date: 2022-06-20
permalink: /first-blog-ghpages
---
Content for your bog post
```
其中`title`是博客文章的标题，显示在主页和文章详情页上；`date`是博客文章的日期；`permalink`是通往文章详情页的路径。
### 静态资源
`static` 文件夹的内容会被复制到你的博客根部，并可通过 `http://[blogurl]/filename` 访问。
## 配置GitHub Actions
一旦你创建好了你的博客仓库，需要在你的仓库中配置GitHub Actions，在 `.github/workflows/deploy.yml` 创建GitHub Actions自动部署流程文件，内容如下：
```yaml
name: Build and Deploy
on: [push]
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Deploy
uses: zonemeen/gitpress@v1.0.12 # 查看 https://github.com/marketplace/actions/gitpress-deploy-blog-action，使用最新版本
with:
branch: gh-pages # GitHub Pages的可选分支
```