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的
评论没有发现