README

适用于 Laravel 的易于使用的产品文档软件包。

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

主要功能

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

• 多产品支持
  • Docweaver 默认支持多个产品。只需创建您的产品文件夹，并将文档版本目录放入其中。
• 即插即用
  • 只需安装和配置，您就可以成功了！ (约 2 分钟)

安装 & 使用

安装

通过 composer 安装；在控制台

composer require reliqarts/laravel-docweaver

或在 composer.json 中要求

{
    "require": {
        "reliqarts/laravel-docweaver": "^2.0"
    }
}

然后在您的终端中运行 composer update 以将其拉入。

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

ReliqArts\Docweaver\ServiceProvider::class,

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

php artisan storage:link

参见： https://laravel.net.cn/docs/master/filesystem

最后，发布软件包资源和配置

php artisan vendor:publish --provider="ReliqArts\Docweaver\ServiceProvider"

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

php artisan vendor:publish --provider="ReliqArts\Docweaver\ServiceProvider" --tag="docweaver-config"

设置

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

示例环境配置

DOCWEAVER_ROUTE_PREFIX=docs
DOCWEAVER_DIR=resources/docs

这些变量以及更多都在 config 文件中有说明。

文档目录

文档目录是放置您的项目文档目录的地方。它可以使用配置密钥 docweaver.storage.dir 或环境变量 DOCWEAVER_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 资源目录中的图片。

  要使用图像目录中的 foo.jpg，您需要将 image_url 设置为 {{docs}}/images/foo.jpg。

  有关更多信息，请参阅： 资产

致谢

此软件包受 Laravel 的 文档 启发，并使用其底层机制作为基础。