深圳網(wǎng)站建設公司關于外貿(mào)網(wǎng)站設計使用SassDoc文檔系統(tǒng)的以及安裝方法。網(wǎng)站建設公司在前面相關文章中說過Hologram 是一個格式非常自由的文檔系統(tǒng),它并不關心它的內(nèi)容,以及它寫在什么類型的文件中。它就像是一張白紙,它是什么取決于你讓它成為什么。
SassDoc(http://sassdoc.com/)則完全相反。它是一個記錄 Sass 的變量、混入、繼承和函數(shù)的工具,而且對每個注釋塊后面的代碼都有嚴格的要求。另外,它對文檔的呈現(xiàn)和風格也很講究。Hologram 只是把文檔分成不同的組,而 SassDoc 則會自動建立起變量和函數(shù)或者混入和擴展的映射關系。如果你在編寫一個大型的基于 Sass 的設計系統(tǒng)或者一個 Sass 框架,而且你不想手寫所有的文檔,那么 SassDoc 將是你的最佳選擇!接下來看看如何開始使用 SassDoc。
網(wǎng)站建設怎樣安裝SassDoc?

SassDoc 是一個基于 NodeJS 的文檔系統(tǒng),而且擁有 Grunt、Gulp 和 Broccoli 的插件。你可以在命令行中對你項目中的 Sass 文件運行 SassDoc。鑒于輸出的內(nèi)容總是一致的,為了簡單起見,我將演示命令行選項。這種方式可以讓你在不改動項目的前提下開始使用 SassDoc。我們從把 SassDoc 安裝為全局的 NPM 包開始(網(wǎng)站建設公司工程師再次提醒,這只是為了能更簡單地試用 SassDoc,如果在實際項目中使用,你可能不會使用全局選項):
$ npm install sassdoc ——global
把 SassDoc 安裝進全局 NPM 文件夾后,就可以直接在 sass 文件夾中運行 sassdoc 指令了:
sassdoc sass
這就是它的用法!SassDoc 會遍歷 sass 文件夾中的所有文件,并提取出所有符合 SassDoc 文檔特殊語法的內(nèi)容。然后,它會使用這些信息構建一個功能齊全的靜態(tài)文檔網(wǎng)站。接下來看一下 SassDoc 的語法,以及帶有 SassDoc 格式注釋的代碼在編譯后會變成什么樣。
網(wǎng)站建設公司工程是關于使用SassDoc方法介紹
SassDoc 使用三個斜杠的 Sass 注釋來指定哪些代碼是需要被納入到文檔中的。你需要做的就是把 /// 放在一個混入、擴展、函數(shù)或者變量的上面,然后 SassDoc 就會幫你做其余的事情。下面是一個僅僅用到兩個變量的例子:
///
$button-padding:1em;
$button-font-size:1.2em;
在前面的例子中,變量 $button-padding 會被導入 SassDoc,而變量 $button-font-size 則不會。SassDoc 能夠智能地抓取緊跟在標記后面的變量,即使你把兩個變量放在同一行中,SassDoc 仍然只會導入第一個。如果你希望兩個都導入,可以這樣寫:
///
$button-padding:1em;
///
$button-margin:1.2em;
僅僅用了兩個變量、六個斜杠和一個終端命令。
深圳網(wǎng)站建設公司總結
正如本章的示例所闡釋的,靜態(tài)文檔系統(tǒng)可以是獲取設計系統(tǒng)中的輸入和輸出的有效途徑。Hologram 為創(chuàng)建一系列開放和個性化的文檔頁面提供了工具。無論是編寫入門文檔,還是獲取一個行動召喚(call to action, CTA)按鈕的正確標記,Hologram 都會提供充分的靈活性,讓你編寫、歸類,并且以想要的風格來展示。如果你在尋找為你的 Sass 系統(tǒng)創(chuàng)建更嚴格和更標準的視圖的文檔工具,那么 SassDoc 就是你上手的最佳選擇。雖然它仍然是靜態(tài)的文檔工具,但它通過連接系統(tǒng)的依賴關系,提升了構建文檔的自動化程度。事實上,這兩個工具不是彼此獨立的。很多現(xiàn)代的樣式文檔是用幾種不同的工具構建的,每一種工具盡可能用最佳的方式來展示系統(tǒng)的不同部分。這兩個工具的共同點在于,它們都依賴大量的用戶輸入來發(fā)揮真正的潛力。作為靜態(tài)文檔工具,它們提供了一種方式,讓我們能夠為正在搭建的網(wǎng)站編寫文檔,并把所有的信息整理、歸類并建立索引。此外,代碼驅(qū)動的文檔系統(tǒng)是另一種方式。在代碼驅(qū)動的環(huán)境下,文檔純粹是由我們所編寫的代碼生成的。下一章將會舉一些相關的例子。好了,
深圳網(wǎng)站建設公司本文關于“外貿(mào)網(wǎng)站設計使用SassDoc文檔系統(tǒng)的以及安裝方法”就分享到這里。您需要聯(lián)系深圳專業(yè)外貿(mào)網(wǎng)站建設公司定制商城等平臺,請撥打網(wǎng)站建設聯(lián)系電話,有專人為您提供技術性的解答。謝謝關注,博納網(wǎng)絡編輯整理。