项目简介
本项目名为GoRush,是一个基于Go语言的网站框架。其核心目标是为开发者提供自由、快速且便捷的网站服务构建方式,允许使用者依据自身需求自定义网站,同时尽可能降低网站构建的门槛。
项目的主要特性和功能
- 模板驱动:可借助模板文件生成网页,用户能自行定制模板以满足个性化需求。
- 快速构建:通过
gorush
命令行工具,能轻松实现网站的构建与预览。 - 静态化处理:可生成静态网页,便于博客等内容的托管。
- 文章分类功能:支持对文章进行分类,方便内容的组织与浏览。
- 友好命令行界面:提供易于操作的命令行界面,便于网站的构建和管理。
安装使用步骤
安装前提
确保系统已安装Go语言环境。
安装GoRush
运行以下命令安装最新版本的GoRush:
shell
使用命令
gorush get
:初始化资源,仅在项目初始化时调用。gorush build
:从模板构建docs
公开文件夹。gorush serve
:构建并运行服务,该命令包含build
流程。gorush clean
:快速清理项目文件。gorush new
:新建文章或页面。
项目结构
使用gorush get
初始化后的项目结构如下:
shell
.
├── assets # 静态资源文件夹
│ └── css
├── config.toml # 配置文件
├── content # 用户工作区
│ ├── pages
│ └── posts
│ └── drafts # 草稿,构建时将默认忽略此处的内容
├── License # 默认使用的License
├── README.md # 空README文件
├── static # static文件夹内资源将以原样生成在docs文件夹根目录,暂不能存在目录
└── templates # 模板文件夹,用户将在此自定义页面样式
├── common # 通用的一些模板,包括导航区、头文件等
├── pages # 全部页面模板
└── posts # 文章的一些模板,默认为Basic
└── Basic
配置文件
配置文件为config.toml
,位于项目主目录下,程序运行前需建立该文件。使用gorush get
会生成如下配置文件:
```toml
[pages]
contentOnlyPages=["about"] //基础页面列表
[posts] excludeDirs=["drafts"] //文章构建所忽略的目录
[server] addr="localhost:9090" //监听地址 ```
工作流程
- 新建文件夹并进入,可选择执行
git init
(若不使用git可跳过),然后运行gorush get
初始化项目。 - 在
content/posts
文件夹中创建内容,建议使用gorush new
命令,如创建文章gorush new 分类/文章名称
,创建页面gorush new -p 页面名称
。 - 运行
gorush serve
,在浏览器对应端口(默认"localhost:9090")预览。
注意事项
- 切勿直接操作
docs
文件夹,它会在gorush serve
或gorush build
时自动删除和重构。 - 若要更改网页内容,应修改
templates
下的模板文件。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】