核心内容摘要
5步掌握鸣潮自动化：从需求到优化的全栈指南
本文简介对于经常写作的工友来说除了在各个平台上发布文章其实还可以把自己的专栏整理成一本“在线书”分享到网上方便系统阅读和沉淀内容。
市面上这类工具不少比如 VitePress、Docusaurus 等等。
但今天我想安利一个更轻量、也更易上手的工具 ——GitBook。
GitBook 插件丰富、界面友好而且使用流程非常简单。
只需 3 步就能轻松把你的专栏整理上线安装环境开始写书发布在动手之前你需要注册好 GitBook 和 GitHub 账号。
GitBookhttps://www.gitbook.com/GitHubhttps://github.com/ 安装环境首先你需要在电脑上安装好Node.js下载地址在官网https://nodejs.org/建议不要一味追求最新版本因为 Node 太新也可能没法跑 GitBook。
你也可以借助nvmNode 版本管理工具来切换不同版本的 Node灵活又方便。
环境准备好后打开终端Terminal / CMD输入以下命令全局安装 GitBooknpm install gitbook -g安装完成后可以用下面这个命令验证一下gitbook -V如果终端顺利输出了 GitBook 的版本号就说明安装成功啦✍️ 开始写书先找个文件夹放你的项目我这边以《任天堂物语》为例新建了一个gitbook-nintendo-story文件夹。
在gitbook-nintendo-story目录下至少要创建两个文件README.mdSUMMARY.md
写好 README.mdREADME.md就像整本书的封面和简介用一句话告诉读者你这本书讲什么。
比如我在README.md里写# 任天堂物语 从花札到游戏机任天堂百年传奇藏着无数人的童年光影。
回头看看那些游戏仍在发光。
这样打开就能让人一眼知道你这本「任天堂物语」的调性和内容。
搭好 SUMMARY.mdSUMMARY.md就是目录用来告诉 GitBook 每章放在哪儿、怎么组织。
格式其实很简单就是列表加链接。
例如# Summary * [专栏简介](README.md) * 故事 * [史前任天堂在梦开始之前](./chapter/001史前任天堂在梦开始之前/README.md) * [纸梦初成任天堂的诞生](./chapter/002纸梦初成任天堂的诞生/README.md)提示链接里可以引用子文件夹比如./chapter/001_XXX/README.md以此类推。
创建章节目录目录搞定后就可以按照章节来写文章了。
我在项目里新建了一个chapter文件夹把
、
放进来结构大概像这样├── README.md ├── SUMMARY.md ├── chapter │ ├── 001史前任天堂在梦开始之前/README.md │ └── 002纸梦初成任天堂的诞生/README.md └── chapter2 └── README.md每个章节都放一个单独的子文件夹文件夹里放对应的README.md以及配图。
这样目录清晰、管理也更方便。
好了这样就完成了基本的文件布局接下来就可以开始在各个章节的README.md里填内容啦
运行项目完成前面的操作后使用gitbook init命令初始化项目。
然后使用gitbook serve命令就可以把项目运行起来看看它长什么样子。
项目运行成功后在浏览器访问http://localhost:4000 发布你的在线书籍到这里你的项目已经准备就绪就差把它发布到网上让更多人看到了。
把项目推送到 GitHub先在 GitHub 上新建一个空仓库。
按照页面提示复制对应的命令把本地的gitbook-nintendo-story或你自己的项目文件夹提交并推送到 GitHub。
等待几秒钟确认仓库里能看到你的所有文件。
在 GitBook 上创建 Space 并同步 GitHub登录 GitBook 后点击左侧 “Spaces” 旁边的 “” 号新建一个 Space。
在创建时选择 “Set up Git Sync” → “GitHub Sync”。
最后记得选择“GitHub to GitBook”这样以后每次更新完你的书籍上传到 GitHub 后GitBook 也会自动把内容同步过来。
GitBook 会让你授权访问 GitHub选择刚才创建的仓库同步完成后你就能在 GitBook 里看到项目内容了。
预览并发布为 Docs Site在 GitBook 后台选中刚刚同步过来的 Space。
点击页面上方的 “Preview” 按钮然后选择 “Publish as a docs site”。
按照提示创建一个新的 Site。
创建完成后回到 “Docs sites” 列表选中新站点点击右上角的 “Publish”。
等待几秒GitBook 会自动将你的网站公开你就能访问到在线版的“任天堂物语”了。
自定义二级域名可选如果你想让网址更好记可以在 Site 设置里修改二级域名比如nintendo-story。
修改完毕后保存并等待几分钟新的域名就会生效访问时会自动跳转到你刚发布好的文档站点。
完成以上步骤后你的专栏就正式上线任何人都可以通过你的 GitBook URL或自定义域名访问、浏览和分享你的作品啦https://rabbit-svip.gitbook.io/nintendo-story/轻量工具三步就能快速上线结构化在线文档高效沉淀内容。
但落地多项目时同步与定制化开发会耗精力。
不妨看看侧重效率的RollCode 低代码平台其私有化部署、自定义组件、静态页面发布SSG SEO能解这类痛点。
以上就是本文的全部内容了如果本文对你有帮助的话也请各位工友三连转发给你的工友。