README

一个简单的 Laravel 5.x 产品文档包。

Docweaver 适用于产品文档和/或知识库。将 .md 文件夹转换为完整的文档。Docweaver 受 Laravel 自身文档的启发。

主要功能

Docweaver 提供以下功能以及更多。

• 多产品支持
  • Doc Weaver 支持开箱即用的多个产品。只需创建您的产品文件夹，并将文档版本目录放入其中。
• 即插即用
  • 只需安装和配置即可！（大约 2 分钟）

安装与使用

安装

通过 composer 安装；在控制台

composer require reliqarts/docweaver

或在 composer.json 中要求

{
    "require": {
        "reliqarts/docweaver": "^1.0"
    }
}

然后在您的终端中运行 composer update 以拉取它。

完成此操作后，您需要将服务提供者添加到 app.php 配置文件中的 providers 数组中，如下所示：（注意：此包支持 Laravel 的包自动发现；如果您使用的是 Laravel 5.5 或更高版本，可以跳过此步骤。）

ReliQArts\Docweaver\DocweaverServiceProvider::class,

确保您的应用程序公共存储目录已链接并可由浏览器访问。

php artisan storage:link

查看：[Laravel 文件系统文档](https://laravel.net.cn/docs/5.5/filesystem)

最后，发布包资源和配置

php artisan vendor:publish --provider="ReliQArts\Docweaver\DocweaverServiceProvider"

您可以选择使用 docweaver:config 标签仅发布配置

php artisan vendor:publish --provider="ReliQArts\Docweaver\DocweaverServiceProvider" --tag="docweaver:config"

您可以使用类似的标签 migrations 以类似方式发布迁移。

设置

设置所需的环境变量，以便包知道您的图像模型、控制器等。

示例环境配置

DOC_WEAVER_ROUTE_PREFIX=docs
DOC_WEAVER_DIR=resources/docs

这些变量以及更多内容在 config 文件中有详细说明。

文档目录

文档目录是您放置项目文档目录的位置。它可以使用配置键 docweaver.storage.dir 或环境变量 DOC_WEAVER_DIR 来更改。默认文档目录是 resources/docs。

结构

每个项目目录应包含每个文档版本单独的文件夹。每个版本至少必须有两个（2）Markdown 文件，分别是 documentation.md 和 installation.md，分别用作侧边栏和初始文档页面。

[doc dir]
    │
    └─── Project One
    │       └── 1.0 
    │       └── 2.1
    │            └── .docweaver.yml       # meta file (optional)
    │            └── documentation.md     # sidebar nav
    │            └── installation.md      # initial page
    │
    └─── Project Two

元文件

每个文档版本的配置可以放在 .docweaver.yml 中。支持的设置包括

• name

  产品名称。

• description

  产品描述。

• image_url

  产品图片 URL。这可能是一个绝对 URL（例如 http://mywebsite.com/myimage.jpg）或位于 images 资源目录中的图片。

  要使用位于 images 目录中的 foo.jpg，您应将 image_url 设置为 {{docs}}/images/foo.jpg。

  更多信息请参阅：[资产](https://github.com/hollysocial/laravel-docweaver/blob/HEAD//docs/%7B%7Bversion%7D%7D/assets)

鸣谢

此包受 Laravel 的 [文档](https://github.com/laravel/laravel) 启发，并使用其底层机制作为基础。