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资源目录中的图片。

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

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

致谢

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