1 Star 0 Fork 12

落在南方 / zink

forked from HanJinyan / Meink 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

Meink是一个基于Golang的轻量级静态博客构建工具,可以快速搭建博客网站。它无依赖跨平台,配置简单构建快速,以Markdown格式文本输入源,注重简洁易用.

快速预览,可以关注我的个人博客:www.jinyan.ink 项目源码整体比较简单,适合初学者练手学习项目。

特点

  • YAML格式的配置
  • Markdown格式的文章
  • 无依赖跨平台
  • 超快的构建速度(并发)
  • 简单,小巧,易用
  • 源码简单,适合初学者练手

快速开始

下载,安装Golang

go version go1.14 linux/amd64
  • 注:go mod 模式开启

下载源码

go get github.com/HanJinyan/Meink

编译源码并运行 (Linux)

hanjinyan@hanjinyan:~/app/src/Meink$ go build
hanjinyan@hanjinyan:~/app/src/Meink$ ./Meink run

浏览器打开:localhost:8080  进行预览

命令

$ ./Meink run      运行博客
$ ./Meink init     清空public (用于调试)
$ ./Meink relaese  发布版打包到release文件夹
$ ./Meink new      创建文章
$ ./Meink sync     同步文章到服务器

网站配置

编辑config.yml,使用格式:

site:
  title: "Meink· 轻量级静态博客构建工具"   # 网站名称
  subtitle: "Keep It Simple & Stupid"   # 网站首页字幕
  limit: 5                              # 每页文章数
  theme: theme                          # 主题名称(默认是theme)
  language: zh-cn                       # 网站显示语言(可选zh-cn ,en )
  url: "http://www.jinyan.ink"          # 网站url
  root: "/Meink"                        # 网站根目录
  copyright: "你的备案号"                 # 网站备案号
  email: "你的邮箱" 
  github: "你的Github名称"
  link: "{year}{month}{day}{hour}{minute}{second}.html" #文章连接


authors:
  me:
    name: "Meink"                       # 文章作者名
    intro: "Meink"                      # 文章作者描述
    avatar: "/author.png"               # 文章作者logo

comment:                                # 借助Valine实现评论模块
  appid: "Valine配置appid"
  appkey: "Valine配置appkey"

build:
    output: "public"                    # 输出目录
    source: "source"                    # 文章存放目录
    port: 8080                          # 输出端口
    copy:
        - "source"

publish:
  release: |
    `./release.sh .`                    # 编译发布版脚本
  sync: |                               # 文章同步到服务器的命令
    sshpass -p 你的服务器密码 scp -r /home/hanjinyan/app/src/Meink/ root@你的服务器ip:/目录

写作

用命令创建

./Meink new blog_name  # 创建文章
  • blog_name.md文件在source/xxxx年-xx月-xx日 文件夹下

文章格式

编辑.md文件,使用格式:

title: Meink                    # 文章名称
date: 2020-03-27 18:47:26       # 文章时间(自动生成)
update: 2020-03-27 18:47:26     # 文章更新时间(手动生成)
author: me                      # 文章作者(默认me)
cover:                          # 文章封面
draft: false                    # 是否为草稿(草稿不渲染)
top: false                      # 是否置顶
type: post                      # 文章类型(post为文章 , page 为页面)
hide: false                     # 是否隐藏(隐藏文章不渲染)
tags:                           # 文章标签
    - Meink
    - GitHub
preview:                        # 文章预览内容
---------------------
Markdown 格式的正文

用命令创建页面

./Meink new page_name  # 创建页面

页面格式

编辑.md文件,使用格式:

type: page                      # 类型(post为文章 , page 为页面)
title: "关于"                    # 页面标题       
---
Markdown 格式的正文

手动创建

  • .md创建在source文件夹下 (允许子文件)

二次开发

欢迎各位爱好者提建议,二次开发,源码交流

联系我

QQ : 994205825

微信: HBY205825

邮箱:hby0210@163.com

MIT License Copyright (c) 2020 落在南方 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

基于Golang的轻量级静态blog,简单,小巧,易用。快速预览地址: 展开 收起
Go
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Go
1
https://gitee.com/zzl/zink.git
git@gitee.com:zzl/zink.git
zzl
zink
zink
master

搜索帮助