Skip to content
hitzhangjiePublic

About

a gitbook utility based on golang

Resources

Stars

2 stars

Watchers

0 watching

Forks

Latest commit

 

History

27 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitBook CLI (Go 重写版)

一个基于 Go 语言重写的 GitBook 命令行工具,提供简洁高效的 GitBook 常用操作。

项目背景

GitBook CLI 是一个已被废弃的 JavaScript 项目。虽然社区有贡献者基于 TypeScript 进行了重写,但使用体验仍不够理想。本项目使用 Go 语言和简单的前端技术,对 GitBook 的常用操作进行了重新实现,旨在提供更稳定、更快速的工具体验。

特性

  • 🚀 高性能: 基于 Go 语言,启动速度快,资源占用低
  • 📦 轻量级: 单一二进制文件,无需 Node.js 环境
  • 🔧 简单易用: 保持与原生 GitBook CLI 相似的命令接口
  • 📚 功能完整: 支持书籍初始化、本地预览、静态构建、电子书导出等核心功能
  • 🎨 现代化界面: 简洁美观的前端预览界面

安装

从源码构建

git clone https://github.com/hitzhangjie/gitbook.git
cd gitbook/gitbook
go build -o gitbook

使用 Go 安装

go install github.com/hitzhangjie/gitbook@latest

快速开始

初始化一个 GitBook 项目

gitbook init

这将在当前目录创建一个新的 GitBook 项目,包含:

  • book.json - 书籍配置文件
  • README.md - 书籍介绍
  • SUMMARY.md - 目录结构

本地预览

gitbook serve

启动本地开发服务器,默认在 http://localhost:4000 预览你的书籍。支持热重载,修改文件后自动刷新。

构建静态网站

gitbook build [book] [output]

将 GitBook 项目构建为静态网站,输出到指定目录。

导出电子书

支持导出为多种格式:

# 导出 PDF
gitbook pdf [book] [output]

# 导出 EPUB
gitbook epub [book] [output]

# 导出 MOBI
gitbook mobi [book] [output]

命令说明

命令 说明 用法
init 初始化一个新的 GitBook 项目 gitbook init [directory]
serve 启动本地预览服务器 gitbook serve [book]
build 构建静态网站 gitbook build [book] [output]
pdf 导出为 PDF 格式 gitbook pdf [book] [output]
epub 导出为 EPUB 格式 gitbook epub [book] [output]
mobi 导出为 MOBI 格式 gitbook mobi [book] [output]
version 显示版本信息 gitbook version

项目结构

gitbook/
├── gitbook/              # 主程序
│   ├── main.go          # 入口文件
│   ├── commands/        # 命令实现
│   │   ├── cmd_init.go
│   │   ├── cmd_serve.go
│   │   ├── cmd_build.go
│   │   ├── cmd_pdf.go
│   │   ├── cmd_epub.go
│   │   ├── cmd_mobi.go
│   │   └── cmd_version.go
│   ├── book/            # 书籍配置和解析
│   ├── builder/          # 静态网站构建器
│   ├── server/           # 本地预览服务器
│   └── ebook/            # 电子书生成器
└── README.md

技术栈

  • 后端: Go 1.24+
  • 前端: 原生 JavaScript + CSS
  • 依赖管理: Go Modules
  • 命令行框架: Cobra

开发

环境要求

  • Go 1.24 或更高版本

构建

cd gitbook
go build -o gitbook

运行测试

go test ./...

贡献

欢迎提交 Issue 和 Pull Request!

许可证

本项目采用 MIT 许可证。

致谢

本项目基于已废弃的 GitBook CLI 2.3.2 版本重写,感谢原项目及其社区贡献者的工作。

About

a gitbook utility based on golang

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages