README

markdown 维基/博客

用法

将您的 markdown 文件放在 /wiki 目录中。

如果您在一个分类或子分类目录中放置了一个 index.md 文件，它将在子分类和文件列表之后被解析并显示。

视图是 blade 模板，位于 resources/views/wiki，主布局模板位于 resources/views/master.blade.php

安装

使用 composer

$ composer create-project fungku/kwiki --prefer-dist

设置

从项目根目录，将 .env.example 重命名为 .env

$ mv .env.example .env

编辑 .env 以适应您的环境。例如，在您的生产服务器上将 local 改为 production，并将调试改为 false。

使用不同的解析器

默认使用的 markdown 解析器是 erusev/parsedown。要使用不同的解析器，您需要创建自己的实现 Parseable 接口的解析器，或者为不同的库创建一个适配器，该库实现了 Parseable。然后，您应该在 app/Providers/AppServiceProvider.php 中更改绑定到您自定义的解析器。

$this->app->bind(Parseable::class, MyCustomParser::class);

理解传递给您的视图的数据

您将在维基页面视图中使用四个变量

$title 是文章或分类的标题。
$breadcrumbs 是一个带有 href 和 name 索引的面包屑数组
$index 在您导航到一个目录时可用，否则为空数组
- $index['subcategories'] 是您当前目录中的子目录数组，带有 href 和 name 索引
- $index['files'] 是您当前目录中的文件数组，带有 href 和 name 索引
$post 是解析后的 markdown 内容的字符串

更改默认目录

移动或重命名您的维基目录到您想要的位置。只需更新 app/Http/Controllers/WikiController.php 中的变量 $wikiPath。

移动或重命名您的维基视图模板到您想要的位置。只需更新 app/Http/Controllers/WikiController.php 中的变量 $wikiView。

默认样式非常基础

默认情况下，我们包含来自 CDN 的 bootswatch 主题和 public/css/app.css 用于自定义样式。

导航到分类的示例

计划

近期计划可能是更好的默认样式。否则，我完全欢迎批评和建议，因为它已经满足了我的需求。

我可能从中提取一个包，但由于路由、控制器和服务提供者的原因，它将是 laravel 特定的。

如果您想要 Laravel 之外的东西，您可以自己编写，并且您可能对下面的 pagemark 包感兴趣。

由以下提供支持

Lumen - Laravel 的官方微框架
Pagemark - 我编写的一个包，基本上做了所有的工作
Parsedown - 一个流行的 markdown 解析器，这也是本项目的默认解析器

fungku / kwiki

维护者

详情