SassDoc的靈感和之後的 JSDoc 藍本。
就像任何其他文檔生成,SassDoc的工作原理是抓住從上海社會科學院/ SCSS文件的意見和創造一個美麗的,組織良好的HTML文檔頁面了出來。
所有內容以及結構分為部分處理函數,變量和混入。還支持引用原代碼段和源代碼高亮。
除了標準SassDoc主題,其他模板也可提供。
要使用SassDoc請首先檢查其文檔,了解有關如何格式化SASS / SCSS源代碼註釋,使他們能夠檢測和使用SassDoc發動機的相應信息。
什麼是新的在此版本中:
- 在升級到5.0通天
- 在確保默認主題名稱是否正確登錄
- 在一些依賴更新
- 在切換到ESLint
什麼是2.1.1版本,新的:
- 在更新青菜,轉換的版本,以防止6to5-在運行時的問題進行說明。
什麼是2.0.0版本,新的:
- 在整個API已經完全重構ES6
- 在@parameter標註定義名字的時候$符號現在是可選
- 現在可以使用的文件/文件夾排除模式
- 現在可以通過管道SassDoc成標準輸入
- - 調試選項已被添加到輸出的信息對當前設置
- 在默認的主題,現在有一個googleAnalytics配置接受谷歌Analytics(分析)跟踪的關鍵
- 在默認的主題,現在有一個trackingCode配置接受任意HTML片段之前,包括< /身體>
- 在@content註釋現在是在默認主題正確輸出
- 在默認的主題現在顯示的類型,以及名字的時候交聯項目(要求,等...)
- 在錯誤信息應該更明確,提供的文件名和行
- - 解析選項已被添加到輸出的原始分析數據作為JSON從CLI
現在
什麼的1.10.6版本是新的:
- 在確保適當的類型檢查@see註釋
什麼的1.10.3版本是新的:
- 在已阻止@Requires自動填充依賴兩次
什麼是1.8.0版本,新的:
- 添加到您自己的註釋添加到您的主題的能力
- 修正了物品被隨機排序
什麼在1.6.0版本新:
- 在增加了約曼發電機,使其更容易建立主題。
- 在配置文件中添加了YAML支持;默認的配置文件名仍然認為,無論是作為.json,.yaml或.yml。
- 添加一條消息,警告反對依靠默認的配置文件名(查看{JSON,YAML,陽明}),因為它會在2.0.0版本支持.sassdocrc(這將支持格式打破一次,而更加語義,減少混亂和不太可能與其他項目衝突)。
- 修正了當變量物品的價值包含了一個分號的問題。
- 在提高光的主題(更好的側邊欄切換存儲在localStorage的狀態,更好的代碼切換,更好的JavaScript結構,更好的性能)。
什麼在1.5.2版本新:
- 在添加隱式類型所需的佔位符
什麼在1.4.1版本新:
- 修正了一個破碎的測試
什麼在1.3.2版本新:
- 修正了一個破碎的測試
什麼版本1.1.6的新:
- 在反向移植,固定發現,在以絕對路徑。
要求:
- 在Node.js的
評論沒有發現