Skip to content

moduleinfo.json installation does not seem to work as documented #161

Description

@grandeljay

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?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions