通过 
搜索
搜索raketman / wiki-markdown
dev-master
2023-04-04 07:42 UTC
Requires
- php: >=7.2.5
- ext-ctype: *
- ext-iconv: *
- doctrine/annotations: ^1.0
- guzzlehttp/psr7: ^1.8
- kriswallsmith/buzz: ^1.2
- meilisearch/meilisearch-php: ^0.17.0
- nyholm/psr7: ^1.4
- php-http/curl-client: ^2.2
- php-http/message: ^1.11
- phpdocumentor/reflection-docblock: ^5.2
- symfony/console: 5.2.*
- symfony/dotenv: 5.2.*
- symfony/flex: ^1.3.1
- symfony/framework-bundle: 5.2.*
- symfony/monolog-bundle: ^3.6
- symfony/process: 5.2.*
- symfony/property-access: 5.2.*
- symfony/property-info: 5.2.*
- symfony/serializer: 5.2.*
- symfony/twig-bundle: 5.2.*
- symfony/yaml: 5.2.*
Requires (Dev)
- symfony/browser-kit: ^5.2
- symfony/css-selector: ^5.2
- symfony/phpunit-bridge: ^5.2
Conflicts
Replaces
This package is auto-updated.
Last update: 2024-09-04 10:53:41 UTC
README
快速开始
创建wiki页面
docker run -v {wiki_path}:/var/www/app/docs -p {port}:8000 raketman/wiki
Wiki将在您的机器上端口号：{port}上可用。
尝试演示
git clone https://github.com/raketman/wiki-markdown.git
docker run -v $(pwd)/wiki-markdown/docs_example:/var/www/app/docs -p 74:8000 raketman/wiki
Wiki在127.0.0.1:74或0.0.0.0:74上打开
代理转发
如果需要在您的应用程序的部分打开wiki，例如your_app_address/wiki。
您需要在docker中添加环境变量APP_PREFIX
docker run -v $(pwd)/../docs2:/var/www/app/docs -p 74:8000 -e APP_PREFIX=/wiki raketman/wiki
当然，wiki中所有图片的URL必须是相对路径，不是绝对路径，例如
work wine
work wrong
需要发送不带前缀的wikiapp uri，您需要一个干净的prefix，例如nginx
location /wiki {
rewrite /wiki/(.*) /$1 break;
proxy_pass 0.0.0.0:74
}
在docker目录中，您可以查看带有示例APP_PREFIX的docker-compose
强制更新内容
docker exec -it {container} php bin/console app:wiki:actualize --force=1
Wiki设置
文件设置
文件名取自第一行，删除开头和结尾的#符号
# Описание апи # -> Описание апи
目录设置
.meta - 用于描述文件夹的yaml格式的文件
支持的关键字
title: folder name order: # sorting within a folder, for point adjustment you can write values with a minus filename15: -10 # will be first dirname20: 99999 # will be at the end filename7: -7
过滤
Wiki不包括以下文件：
- 以_开头的
- 以.开头的
- 不包含p的
- 为.html格式的
Wiki不包括以下目录：
- 以.开头的
- 过滤完成后为空目录
搜索
搜索引擎
搜索与meilisearch一起工作