README

这个包是什么？

当我遇到一个项目，该项目已经有一个很好的用户文档wiki时，我制作了这个包，并希望它能在应用中可用。

不幸的是，它在一个单独的仓库中，我不想翻译所有的Markdown到HTML，并保持所有内容的同步。

这个包解决了这个问题。

基本设置

首先，您需要将此仓库要求到您的Laravel项目中。

composer require judahnator/md-to-docs

加载完成后，您需要发布配置文件。运行 php artisan vendor:publish 并选择此包。它将创建一个名为 config/md-to-docs.php 的文件

您可以在其中看到所有配置选项的文档，除了指向您的文档文件的配置。

您的文档文件

您需要将Markdown文件以某种方式放入项目中。您可以将它们粘贴到某个位置（例如storage/docs/可能是一个好地方），或者如果它们更新频率较高，您可以使用composer来抓取它们的仓库。

以下是如何在您的composer.json文件中看起来：

{
    "require": {
        "project/wiki": "dev-master"
    },
    "repositories": [
        {
            "type": "package",
            "package": {
                "name": "project/wiki",
                "version": "dev-master",
                "source": {
                    "url": "git@someprovider.com:you/yourproject.git/wiki",
                    "type": "git",
                    "reference": "origin/master"
                }
            }
        }
    ]
}

一旦您通过composer或简单粘贴将wiki Markdown文件加载到项目中，请将config/md-to-docs.php文件中的docs-path配置值指向您的文档的根路径。

用法

这应该相当简单。一旦您的配置设置完毕，请浏览到您在浏览器中放置文件的位置。这可能是在http://yourdomain.com/docs或http://docs.yourdomain.com/，或者您如何设置。

有关此库如何找到您的Markdown文件的一些重要说明

• 您可以在浏览器中浏览到目录。如果该目录中有一个'index.md'文件，它将被提供。否则，将返回404。
• 您可以在URL中省略.md。 /docs/mypage.md和/docs/mypage都是有效的。
• 链接时好时坏。仍处于WIP状态。