api

用于为您的扩展配置自动生成的HTML文档。 path指定在何处创建与项目根相关的文档。 使用base-url生成sitemap.xml文件为您的文档。 theme用于设置用于生成文档的主题(通过name设置)，以及主题支持传递的任何选项(通过options设置)。 最后，theme-directories被用来提供额外的搜索路径，以找到你想要的主题。

  1. {
  2.     "api": {
  3.         "path": "doc/%version%",
  4.         "base-url": "http://example.local/api/",
  5.         "theme": {
  6.             "name"   : "zephir",
  7.             "options": {
  8.                 "github":           null,
  9.                 "analytics":        null,
  10.                 "main_color":       "#3E6496",
  11.                 "link_color":       "#3E6496",
  12.                 "link_hover_color": "#5F9AE7"
  13.             }
  14.         },
  15.         "theme-directories": [
  16.             "my/api/themes"
  17.         ]
  18.     }
  19. }