Skip to content

GitBook Downloader 是一款基于 Node.js 开发的工具,专为托管在 GitBook 平台的文档站点设计,可一键将全站内容(包括文章、目录结构、图片及附件)以Markdown格式下载至本地。方便后续离线查阅或者添加自己的知识库,Obsdian 笔记等。

License

Notifications You must be signed in to change notification settings

woodcoal/gitbook-downloader

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitBook Downloader

中文】 【English

GitBook Downloader 是一款基于 Node.js 的自动化文档抓取工具,专为 GitBook 托管平台文档下载设计,支持全站内容批量下载(含嵌套目录结构、Markdown 排版、图片及附件资源)。该工具通过模拟浏览器访问实现数据抓取,可无缝对接 Obsidian、Logseq 等双链笔记系统,是构建个人知识库的利器。


方法指南

环境准备

# 要求 Node.js ≥18.x 且已安装 Git
node -v  # 验证Node版本
git clone https://github.com/woodcoal/gitbook-downloader.git
cd gitbook-downloader

安装

npm install  # 推荐使用yarn管理依赖

# 或者
yarn install  # 精确安装依赖版本

基础命令

# 公有文档下载(含图片)
node src/index https://docs.gitbook.com -o ./my_docs

# 私有文档下载(需认证)
node src/index https://internal.company.com/docs \
  -a -u user@company.com -p $SECRET_PASSWORD \
  -i false  # 禁用图片下载

参数说明

短参数 长参数 数据类型 默认值 说明
-a --all string false 对于包含路径的地址是否全站下载
-o --output string ./output 支持绝对/相对路径
-i --images boolean true 使用--no-images禁用下载
-a --auth boolean false 启用 HTTP Basic 认证
-u --username string - 需与-a联用
-p --password string - 建议通过环境变量传递

About

GitBook Downloader 是一款基于 Node.js 开发的工具,专为托管在 GitBook 平台的文档站点设计,可一键将全站内容(包括文章、目录结构、图片及附件)以Markdown格式下载至本地。方便后续离线查阅或者添加自己的知识库,Obsdian 笔记等。

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published