The official documentation states:
installation #
Mit diesem Feld kann die Installationsanleitung für das Modul angegeben werden. Als Alternative hierzu bietet sich an die Anleitung in die Datei install.md zu schreiben.
Which implies that any file can be referenced as an installation instruction.
But if I try to specify a file like this:
{
"installation": "README.md"
}
It does not work. It seems the MMLC makes no attempt to reference it and simply aborts when there is no docs/install.md.
|
/** |
|
* Liefert die install.md als HTML. |
|
*/ |
|
public function getInstallationMd(): string |
|
{ |
|
$docFilePath = $this->getDocFilePath('install.md'); |
|
if (!$docFilePath) { |
|
return ''; |
|
} |
|
$path = $this->getUrlOrLocalRootPath() . $docFilePath; |
|
return FileHelper::readMarkdown($path); |
|
} |
So is the documentation wrong or is this a bug in the MMLC?
The official documentation states:
Which implies that any file can be referenced as an installation instruction.
But if I try to specify a file like this:
{ "installation": "README.md" }It does not work. It seems the MMLC makes no attempt to reference it and simply aborts when there is no
docs/install.md.ModifiedModuleLoaderClient/src/Classes/Module.php
Lines 363 to 374 in 6fa0f70
So is the documentation wrong or is this a bug in the MMLC?