×

深圳网站建设—APP开发—网站制作—小程序开发_博纳网络公司

0755 -
82538016
82560826
网站制作资讯

深圳网站制作公司分享网站制作什么是代码驱动的文档?

文章编辑:网站建设 文章来源:网站制作 浏览量:

    深圳网站制作公司分享网站制作什么是代码驱动的文档?网站制作公司的设计师一般使用Pattern Lab 多平台模式库工具,它使你可以模块化地开发设计系统,并将模板和 CSS 转换成可浏览的模式库。在模块化的系统中,你可以先开发每个单独的模式片段,然后通过组合这些片段产生更复杂的模式。Pattern Lab 提供了一个基本框架,用于模块化地创建并组合这些片段,使之成为更复杂的模式,甚至还能输出完整的页面。可预览的组件库是开发者、设计师、用户体验师、质量工程师和产品所有者聚在一起时可以使用的完美工具。它为设计系统中的每个部分创建了一门通用的语言和稳定的参照系。
     
     网站制作公司认为JSON 模式是用于描述数据格式的语言,同时也可以说明数据的验证方式。在前端架构的领域中,可以用 JSON 模式来描述模板和模式所需要的数据。JSON 超模式甚至可以描述能够通过 HTTP 协议与设计系统交互的方法,包括验证、渲染和测试。JSON 模式是一种代码驱动的文档工具,因为它提供了验证和驱动编辑工具的功能。JSON 模式还提供了可读性很强的系统手册,取代了开发者实现一个功能所需的一大堆手写说明。
网站制作公司分享什么是样式文档
    既然样式表已从一长串的声明演化为一个拥有变量、函数和逻辑的系统,那么也要保证文档系统的演化能跟上节奏。Hologram(http://trulia.github.io/hologram/)提供了构建稳健的文档系统所需的一切内容。它允许我们在实际编写代码时,直接在 Sass 或者 JavaScript 文件中给系统进行注释。Hologram 会自动收集这些注释的内容,并转化为一个含有渲染示例和代码示例的可访问网站。这意味着我们不是在维护两个单独的代码库,而是将样式文档和实际的设计系统结合在一起。如果有任何代码的注释不够充分,那么它就会很容易被发现。
    在系统文档上,Hologram 允许我们在样式文档中创建可访问的标准 Markdown 文件。这给了我们一个绝佳的位置去编写入门文档、项目规则和章程、联系方式,以及其他任何需要收集整理并展示给团队的信息。深圳网站制作公司下面整理了一些文档的例子。
Hologram 是一个 Ruby 库,因此我们从安装库开始:
$ gem install hologram15.1 配置Hologram
安装库之后,我们创建一个 YAML 文件来配置 Hologram:
destination:./docs
documentation_assets:./doc_assets
code_example_templates:./code_example_templates
dependencies:./build
source:./sass
接下来仔细看代码的每一部分。
destination
这是 Hologram 用于输出静态样式文档的文件夹。如果把它设置为可通过外部访问,那么它将会成为公共文件夹,并保存一切样式文档所需的内容。
documentation_assets
这是用来搭建样式文档的静态资源文件。我们需要指定用于生成 HTML 的模板,还有用于改进用户体验的任何 CSS 或 JavaScript。这包括如代码高亮、示例布局、导航样式等内容。如果你还不想为了给网站写文档而去搭建另一个网站,那么可以在 Hologram 的 GitHub 页面(https://github.com/trulia/hologram#extensions-and-plugins)底部所列的现成模板中挑选一个使用。
code_example_templates
代码示例和它们在浏览器中的渲染效果是本样式文档的核心。Hologram 提供了一种非常便捷的方式来自定义示例周围的标记。下面是 Hologram 使用的默认标记,可以根据自己的需要随意修改:
<div class="codeExample">
<div class="exampleOutput">
  <%= rendered_example %>
</div>
<div class="codeBlock">
  <div class="highlight">
   <pre><%= code_example %></pre>
  </div>
</div>
</div>
请注意 rendered_example(渲染示例)和 code_example(代码示例)两个变量。渲染示例是这个例子在页面中直接显示的效果,而代码示例被放置在 <pre> 标签当中,不对其进行渲染,并且加上了代码高亮的类名。
下面快速了解一下 Hologram 的配置,然后再看一些文档的例子。
Hologram 是一个 Ruby 库,因此我们从安装库开始:
$ gem install hologram
好了,深圳网站制作公司本文关于“网站制作什么是代码驱动的文档?”经验就分享到这里。如果您需要深圳专业的网站制作公司定制企业门户、电商平台等网站。请联系我们网站客服,或者拨打我们网站上的制作联系电话,有专业技术人员为您免费提供咨询与解决方案。谢谢关注,博纳网络编辑整理。

当前文章链接:/construction/wzzhizuo/14870.html
如果您觉得案例还不错请帮忙分享:

[声明]本网转载网络媒体稿件是为了传播更多的信息,此类稿件不代表本网观点,本网不承担此类稿件侵权行为的连带责任。故此,如果您发现本网站的内容侵犯了您的版权,请您的相关内容发至此邮箱【qin@198bona.com 】,我们在确认后,会立即删除,保证您的版权。

相关案例推荐