在 Node.js 項(xiàng)目中,我們使用一個(gè)叫做package.json
的文件來(lái)管理項(xiàng)目的依賴(lài)和配置。而對(duì)于基于 GitBook 的項(xiàng)目,則需要使用一個(gè)叫做book.json
的文件來(lái)管理 GitBook 的構(gòu)建和配置。
類(lèi)似于package.json
,book.json
是一個(gè) JSON 格式的文件,它包含了一些關(guān)鍵信息,比如項(xiàng)目的名稱(chēng)、版本號(hào)、語(yǔ)言、作者等。除此之外,book.json
還有一些特殊的配置選項(xiàng),如構(gòu)建配置、插件配置、主題配置等。
{ "title": "My GitBook", "version": "0.0.1", "author": "John Doe", "language": "en", "gitbook": "3.2.2", "plugins": ["sitemap", "search", "highlight"], "pluginsConfig": { "highlight": { "theme": "dracula" } }, "theme": "my-theme", "variables": { "logo": "/images/logo.png" } }
在上面的示例代碼中,我們定義了一個(gè)名為My GitBook
的 GitBook 項(xiàng)目,版本號(hào)為0.0.1
,作者是John Doe
,語(yǔ)言為英語(yǔ)。其中,gitbook
屬性指定了 GitBook 的版本號(hào),plugins
屬性定義了需要使用的插件,pluginsConfig
屬性用來(lái)設(shè)置插件的特定配置,theme
屬性指定了 GitBook 的主題,variables
屬性可以用來(lái)定義主題中的變量。
需要注意的是,book.json
文件中的關(guān)鍵信息會(huì)影響到 GitBook 的構(gòu)建和顯示效果。因此,在進(jìn)行 GitBook 項(xiàng)目的開(kāi)發(fā)和維護(hù)時(shí),需要認(rèn)真設(shè)置和管理book.json
文件。