docs-api-slate:docs api use slate

时间:2024-06-17 16:31:10
【文件属性】:

文件名称:docs-api-slate:docs api use slate

文件大小:246KB

文件格式:ZIP

更新时间:2024-06-17 16:31:10

JavaScript

Slate可帮助您创建美观,智能,响应Swift的API文档。 上面的示例是使用Slate创建的。 在查看。 特征 简洁,直观的设计—使用Slate,API的描述位于文档的左侧,而所有代码示例均位于右侧。 受和API文档启发。 Slate具有响应能力,因此在平板电脑,手机甚至印刷品上看起来都很棒。 一页上的所有内容—用户不得不搜索一百万个页面以查找所需内容的日子已经一去不复返了。 Slate将整个文档放在单个页面上。 但是,我们并未牺牲链接性。 滚动时,浏览器的哈希值将更新为最接近的标头,因此链接到文档中的特定点仍然很自然且容易。 Slate就是Markdown —使用Slate编写文档时,您只是在编写Markdown,这使得编辑和理解变得简单。 一切都以Markdown编写-甚至代码示例也只是Markdown代码块。 用多种语言编写代码示例—如果您的API具有多种编程语言的绑定,


【文件预览】:
docs-api-slate-master
----Vagrantfile(1KB)
----config.rb(1KB)
----LICENSE(569B)
----Gemfile(278B)
----Gemfile.lock(3KB)
----deploy.sh(6KB)
----CHANGELOG.md(6KB)
----lib()
--------toc_data.rb(760B)
--------nesting_unique_head.rb(662B)
--------unique_head.rb(867B)
--------multilang.rb(551B)
----CODE_OF_CONDUCT.md(3KB)
----README.md(7KB)
----source()
--------images()
--------layouts()
--------javascripts()
--------fonts()
--------stylesheets()
--------index.html.md(8KB)
--------includes()
----build()
--------images()
--------javascripts()
--------fonts()
--------index.html(16KB)
--------stylesheets()
----font-selection.json(5KB)

网友评论