savvywombat / wiki-lite
Wiki-Lite:Laravel 5 的轻量级wiki
Requires
- php: ^7.0
- doctrine/dbal: ^2.5
- graham-campbell/markdown: ^8.0
- sebastian/diff: ^2.0
- webpatser/laravel-uuid: ^3.0
- webuni/commonmark-attributes-extension: ^0.5.0
Requires (Dev)
- fzaninotto/faker: ~1.4
- mockery/mockery: ^1.0
- orchestra/testbench: ^3.5
- phpunit/phpunit: ^6.1
README
Wiki-Lite
用于Laravel 5的轻量级wiki
安装
在您的Laravel 5应用程序中,使用 Composer 进行安装。
composer require savvywombat/wiki-lite
您需要发布此包
artisan vendor:publish
并选择
SavvyWombat\WikiLite\ServiceProvider
配置
在 config/wiki-lite.php
中提供了一个示例配置
默认情况下,wiki配置为作为您站点的子目录工作 https://example.com/wiki
。
还配置了匿名用户名(目前,wiki尚未集成到Laravel的认证系统中)。
迁移
Wiki-lite需要两个数据库表,前缀为 wiki_lite_
。
迁移已安装到您项目的 database/migrations
目录。只需运行 artisan migrate
即可安装数据库。
视图
Wiki-lite安装了一个布局模板,它包装wiki视图,允许您修改并将布局集成到您项目的布局中。
模板已安装到 views/vendor/savvywombat/wiki-lite/
使用
首次访问wiki索引页面(https://example.com/wiki
)时,您将需要创建一个带有标题的新页面。
wiki使用 CommonMark 语法,增加了一个新功能 - wiki链接。
在wiki页面之间链接
您可以使用以下方式简单地输入任何页面标题(或别名)作为链接:
[[The page title you want to link to]]
当您保存页面时,您将看到一个链接,该链接会将您带到您想要去的页面。
wiki还会保存从目标页面回链接。
编辑标题
wiki为每个页面使用UUID,这意味着您可以编辑页面标题,并且任何链接到页面以前标题的链接仍然链接到页面的最新版本。
比较修订版本
修订版本比较使用统一差异格式。
样式
模块中包含了一些样式。它们已发布到 resources/assets/sass/vendor/savvywombat/wiki-lite
。
您可以通过在您的 app.scss
文件中添加 @import "vendor/savvywombat/wiki-lite/wiki-lite"
将它们导入到应用程序样式表中。
支持
如果您在此存储库中遇到一般问题,请通过 SavvyWombat 网站联系我们。
请使用GitHub 问题跟踪器报告问题。您也可以fork存储库并提交拉取请求。
如果您正在使用此存储库,我们非常欢迎您的反馈。谢谢!
许可证
Wiki-Lite 在 MIT 许可证 (MIT) 下授权。