深圳网站建设公司关于外贸网站设计使用SassDoc文档系统的以及安装方法。网站建设公司在前面相关文章中说过Hologram 是一个格式非常自由的文档系统,它并不关心它的内容,以及它写在什么类型的文件中。它就像是一张白纸,它是什么取决于你让它成为什么。
SassDoc(http://sassdoc.com/)则完全相反。它是一个记录 Sass 的变量、混入、继承和函数的工具,而且对每个注释块后面的代码都有严格的要求。另外,它对文档的呈现和风格也很讲究。Hologram 只是把文档分成不同的组,而 SassDoc 则会自动建立起变量和函数或者混入和扩展的映射关系。如果你在编写一个大型的基于 Sass 的设计系统或者一个 Sass 框架,而且你不想手写所有的文档,那么 SassDoc 将是你的最佳选择!接下来看看如何开始使用 SassDoc。
网站建设怎样安装SassDoc?
SassDoc 是一个基于 NodeJS 的文档系统,而且拥有 Grunt、Gulp 和 Broccoli 的插件。你可以在命令行中对你项目中的 Sass 文件运行 SassDoc。鉴于输出的内容总是一致的,为了简单起见,我将演示命令行选项。这种方式可以让你在不改动项目的前提下开始使用 SassDoc。我们从把 SassDoc 安装为全局的 NPM 包开始(网站建设公司工程师再次提醒,这只是为了能更简单地试用 SassDoc,如果在实际项目中使用,你可能不会使用全局选项):
$ npm install sassdoc ——global
把 SassDoc 安装进全局 NPM 文件夹后,就可以直接在 sass 文件夹中运行 sassdoc 指令了:
sassdoc sass
这就是它的用法!SassDoc 会遍历 sass 文件夹中的所有文件,并提取出所有符合 SassDoc 文档特殊语法的内容。然后,它会使用这些信息构建一个功能齐全的静态文档网站。接下来看一下 SassDoc 的语法,以及带有 SassDoc 格式注释的代码在编译后会变成什么样。
网站建设公司工程是关于使用SassDoc方法介绍
SassDoc 使用三个斜杠的 Sass 注释来指定哪些代码是需要被纳入到文档中的。你需要做的就是把 /// 放在一个混入、扩展、函数或者变量的上面,然后 SassDoc 就会帮你做其余的事情。下面是一个仅仅用到两个变量的例子:
///
$button-padding:1em;
$button-font-size:1.2em;
在前面的例子中,变量 $button-padding 会被导入 SassDoc,而变量 $button-font-size 则不会。SassDoc 能够智能地抓取紧跟在标记后面的变量,即使你把两个变量放在同一行中,SassDoc 仍然只会导入第一个。如果你希望两个都导入,可以这样写:
///
$button-padding:1em;
///
$button-margin:1.2em;
仅仅用了两个变量、六个斜杠和一个终端命令。
深圳网站建设公司总结
正如本章的示例所阐释的,静态文档系统可以是获取设计系统中的输入和输出的有效途径。Hologram 为创建一系列开放和个性化的文档页面提供了工具。无论是编写入门文档,还是获取一个行动召唤(call to action, CTA)按钮的正确标记,Hologram 都会提供充分的灵活性,让你编写、归类,并且以想要的风格来展示。如果你在寻找为你的 Sass 系统创建更严格和更标准的视图的文档工具,那么 SassDoc 就是你上手的最佳选择。虽然它仍然是静态的文档工具,但它通过连接系统的依赖关系,提升了构建文档的自动化程度。事实上,这两个工具不是彼此独立的。很多现代的样式文档是用几种不同的工具构建的,每一种工具尽可能用最佳的方式来展示系统的不同部分。这两个工具的共同点在于,它们都依赖大量的用户输入来发挥真正的潜力。作为静态文档工具,它们提供了一种方式,让我们能够为正在搭建的网站编写文档,并把所有的信息整理、归类并建立索引。此外,代码驱动的文档系统是另一种方式。在代码驱动的环境下,文档纯粹是由我们所编写的代码生成的。下一章将会举一些相关的例子。好了,
深圳网站建设公司本文关于“外贸网站设计使用SassDoc文档系统的以及安装方法”就分享到这里。您需要联系深圳专业外贸网站建设公司定制商城等平台,请拨打网站建设联系电话,有专人为您提供技术性的解答。谢谢关注,博纳网络编辑整理。