1、簡(jiǎn)介
官網(wǎng)地址:
https://www.gitbook.com/
1.1 工具簡(jiǎn)介
- 什么是 GitBook?
GitBook 是一個(gè)現(xiàn)代文檔平臺(tái),團(tuán)隊(duì)可以在其中記錄從產(chǎn)品到內(nèi)部知識(shí)庫(kù)和 API 的所有內(nèi)容。通過(guò)創(chuàng)建一個(gè)簡(jiǎn)單而強(qiáng)大的平臺(tái)供團(tuán)隊(duì)分享知識(shí),從而幫助團(tuán)隊(duì)更高效地工作。制作一個(gè)用戶友好的協(xié)作產(chǎn)品,讓每個(gè)人都可以通過(guò)文檔創(chuàng)建、編輯和共享知識(shí)。
1.2 使用費(fèi)用
2、安裝
2.1 安裝node
Node.js 是一個(gè)開(kāi)源的、跨平臺(tái)的 JavaScript 運(yùn)行時(shí)環(huán)境。
- 官網(wǎng)地址:
https://nodejs.org/zh-cn
https://nodejs.cn/
-
安裝后如下:
-
通過(guò)如下命令測(cè)試node是否安裝成功。
node -v
npm -v
Node.js 是一個(gè)開(kāi)源和跨平臺(tái)的 JavaScript 運(yùn)行時(shí)環(huán)境。 它是幾乎任何類型項(xiàng)目的流行工具!
Node.js 在瀏覽器之外運(yùn)行 V8 JavaScript 引擎(Google Chrome 的內(nèi)核)。 這使得 Node.js 非常高效。
Node.js 應(yīng)用在單個(gè)進(jìn)程中運(yùn)行,無(wú)需為每個(gè)請(qǐng)求創(chuàng)建新線程。 Node.js 在其標(biāo)準(zhǔn)庫(kù)中提供了一組異步 I/O 原語(yǔ),以防止 JavaScript 代碼阻塞,并且通常,Node.js 中的庫(kù)是使用非阻塞范例編寫(xiě)的,這使得阻塞行為成為異常而不是常態(tài)。
當(dāng) Node.js 執(zhí)行 I/O 操作時(shí),如從網(wǎng)絡(luò)讀取、訪問(wèn)數(shù)據(jù)庫(kù)或文件系統(tǒng),Node.js 不會(huì)阻塞線程和浪費(fèi) CPU 周期等待,而是會(huì)在響應(yīng)返回時(shí)恢復(fù)操作。
這使得 Node.js 可以使用單個(gè)服務(wù)器處理數(shù)千個(gè)并發(fā)連接,而不會(huì)引入管理線程并發(fā)的負(fù)擔(dān)(這可能是錯(cuò)誤的重要來(lái)源)。
- Node.js 最常見(jiàn)的 Hello World 示例是一個(gè) Web 服務(wù)器:
const http = require('http');
const hostname = '127.0.0.1';
const port = 3000;
const server = http.createServer((req, res) => {
res.statusCode = 200;
res.setHeader('Content-Type', 'text/plain');
res.end('Hello World\n');
});
server.listen(port, hostname, () => {
console.log(`Server running at http://${hostname}:${port}/`);
});
要運(yùn)行此代碼段,請(qǐng)將其保存為 server.js 文件并在終端中運(yùn)行 node server.js。
首先先裝nvm,為什么裝這個(gè)?就是node.js各類版本的管理器,隨時(shí)能切換版本。
如果遇到這種情況,只需要改下版本就可以解決了,不需要處理依賴或重裝node.js等問(wèn)題。
# linux系統(tǒng)安裝
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.0/install.sh | bash
# windows 安裝包
https://github.com/coreybutler/nvm-windows/releases/download/1.1.7/nvm-setup.zip
2.2 安裝gitbook
- 安裝gitbook-cli,然后初始化gitbook。
# 切換node版本
nvm install v12.22.3
nvm use v12.22.3
# 配置國(guó)內(nèi)加速鏡像
npm config set registry https://registry.npm.taobao.org
npm install -g gitbook-cli
# 初始化gitbook
gitbook init
gitbook --version
3、測(cè)試
3.1 編輯文檔
- 本地生成文件如下:
- 修改文件SUMMARY.md:
# Summary
* [Introduction](README.md)
* [前言](readme.md)
* [第一章](part1/README.md)
* [第一節(jié)](part1/1.md)
* [第二節(jié)](part1/2.md)
* [第三節(jié)](part1/3.md)
* [第四節(jié)](part1/4.md)
* [第二章](part2/README.md)
* [第三章](part3/README.md)
* [第四章](part4/README.md)
3.2 編譯工程
- 編譯文檔
gitbook build
3.3 預(yù)覽工程
- 預(yù)覽文檔
gitbook serve
- 瀏覽器查看文檔服務(wù)器如下:
文章來(lái)源:http://www.zghlxwxcb.cn/news/detail-818142.html
結(jié)語(yǔ)
如果您覺(jué)得該方法或代碼有一點(diǎn)點(diǎn)用處,可以給作者點(diǎn)個(gè)贊,或打賞杯咖啡;
╮( ̄▽ ̄)╭如果您感覺(jué)方法或代碼不咋地//(ㄒoㄒ)//,就在評(píng)論處留言,作者繼續(xù)改進(jìn);
o_O???如果您需要相關(guān)功能的代碼定制化開(kāi)發(fā),可以留言私信作者;
(????)感謝各位大佬童鞋們的支持!
( ′ ▽′ )? ( ′ ▽′)っ?。?!文章來(lái)源地址http://www.zghlxwxcb.cn/news/detail-818142.html
到了這里,關(guān)于【小沐學(xué)前端】GitBook制作在線電子書(shū)、技術(shù)文檔(gitbook + Markdown + node)的文章就介紹完了。如果您還想了解更多內(nèi)容,請(qǐng)?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章,希望大家以后多多支持TOY模板網(wǎng)!