silverstripe-platform / elder2fs
该包的最新版本(dev-master)没有提供许可证信息。
老式到文件系统转换器
dev-master
2018-07-24 21:16 UTC
Requires
- php: >=5.6
- guzzlehttp/guzzle: ~6.0
- mnapoli/front-yaml: ^1.5
- monolog/monolog: ^1.22
- symfony/yaml: ^2.0
Requires (Dev)
- mockery/mockery: ^0.9
- phpunit/phpunit: ~5.6.8
This package is not auto-updated.
Last update: 2024-09-15 02:27:19 UTC
README
此工具连接到Elder并将KB文章渲染为常规md文件。
安装
composer require "silverstripeltd/elder2fs"
用法
在你的项目根目录中创建 elder2fs.yml
。以下是一个示例
elderUrl: <elder URL>
variables:
platform:
companyName: Terrible Ideas Ltd.
pages:
stuff:
index.md:
url: https://github.com/silverstripe/silverstripe-framework/blob/4/docs/en/index.md
installation.md:
url: https://github.com/silverstripe/silverstripe-framework/tree/4/docs/en/00_Getting_Started/01_Installation/index.md
elderUrl
是Elder运行时的地址。它针对您的特定基础设施。
variables
必须包含渲染KB所需的所有变量,否则Elder API调用将失败。
pages
是输出目录和Markdown文件的树结构。缺失的目录将被创建。
配置完成后,您可以通过以下方式运行elder2fs
vendor/bin/elder2fs
如果是人工操作,您可能想要确保缓存已刷新,尤其是在您刚刚提交了一些更改的情况下
vendor/bin/elder2fs --flush