Skip to content

FlyInTheSky10/Flyblog

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Fly Blog

GitHub license GitHub top language GitHub Repo stars

简介

Fly Blog ,一款基于 Node.js 的静态博客生成器。

Fly Blog 可以将你的 Markdown 文件快速生成一个静态博客!无需服务器,仅需要将生成的静态文件提交至 Github Pages 或其他 Pages 服务,即可建立你的博客!

支持使用$$包含的数学公式渲染 (KaTeX),支持 Font Awesome 图标,支持代码块自动渲染。

注意:Fly Blog 仅处于起步阶段。若使用 Fly Blog 修改了除 assets / source 文件夹的内容,则将难以适配未来的更新。请谨慎修改除 assets / source 文件夹的内容。为了安全起见,请保留好您的 .md 文件。

使用

安装说明

将本仓库 clone 到本地后,在根目录运行

npm install

来安装所需要的依赖库。

然后可以进行连接,将 flyblog 连接到全局

npm link

操作成功后可以直接使用 flyblog 来代替 npm run flyblog 或者 node ./src/index.js

至此,安装完成

使用

flyblog generate

或者

flyblog g

来构建一个静态网页存储于 ./public/

使用

flyblog server

或者

flyblog s

来将网站运行在本地服务器 / localhost 上

使用

flyblog clean

或者

flyblog c

来清理./public/文件夹

使用必知文件

./config.json 配置文件

title:网页标题 subtitle:子标题 author:作者名 description:页面头像下方的文字 rootpath:网页的根位置 (末尾不要出现/) port:本地服务器运行端口 pages:自定义页面的标题title以及在 /src/source/page 中的文件名fileName (不需要后缀)

./src/source/ 文件夹

.md源码文件储存文件夹。

./src/source/post/:存储博客文章的 .md 文件 ./src/source/page/:存储自定义页面的 .md 文件 ./src/source/favicon.ico:网站 ico 图标,不可缺少

./src/assets/ 文件夹

静态文件储存文件夹。

./src/assets/css/:储存输出到 ./public/static/css/ 中的 css 文件 ./src/assets/js/:储存输出到 ./public/static/js/ 中的 js 文件 ./src/assets/images/:储存图片文件,其中./src/assets/images/avatar.jpg 为头像,./src/assets/images/header_background.png 为头像背景图,后缀名文件名可在 ./src/layout/header.ejs 中修改,目前暂不支持自定义文件路径。

./src/layout/ 文件夹

储存 .ejs 模板文件。可以自行修改来达到自定义的效果。现阶段不建议修改此处。

.md 文章格式

文章头与 Hexo 保持一致 例子:

---
title: Vue3.0 仿 12306 前端项目分析
date: 2021-11-09 11:25
categories:
- 前端
tags:
- Vue
- 前端
---
这里是文章内容

简单指南

  1. 安装
npm install
npm link
  1. 配置 /config.json 文件
  2. 将你的 .md 博客原文放入 /src/source/post/,注意上面提到的格式
  3. /config.json中的pages.md 原文放入/src/source/page/
  4. 将网站图标放到 ./src/source/favicon.ico
  5. 将背景图放到 ./src/assets/images/header_background.png
  6. 将头像放到 ./src/assets/images/avatar.jpg
  7. 命令行启动服务器测试
flyblog s
  1. 命令行生成 /public/ 文件夹
flyblog g

然后将 /public/ 中的内容推到 Github Pages 等即可。 (注意有些 Pages 提供的是 CI 服务,请上传源码然后运行后将 Pages 目录指定为 /public/!)

若无法链接,则将命令中的 flyblog 替换为 npm run flyblog 或者 node ./src/index.js