keymanapp / keymanapp/keyman

feat(developer): package compiler should convert .md files to .htm at compile time 🎺

Open
#9,477 3 comments 0 reactions 1 assignee Claimed by @mcdurdin View on GitHub
developer/ developer/compilers/ epic-package-metadata feat
Dominant language
Pascal
Stars
534
Forks
143
Avg merge
2d 10h
Merged PRs (30d)
113

Description

Relates to #9351.

If any of the metadata fields ReadmeFile, LicenseFile, WelcomeFile (see #9478) are listed in a package, and the file it refers to is a .md file, then it should be converted to .htm during the package compile, and the kmp.json file should refer to the .htm, and only the .htm should be included.

Note: don't forget to check for filename conflict when renaming -- if there is also a license.htm in the file, that will cause grief. (Case insensitive comparison reqd)

Another set of questions about multi-file documentation:
* how do we handle internal links between .md files in packages? Need to rewrite the links generated from the .md and build list of all .md files to convert from that?
* if we rename arbitrary.htm (whether generated from arbitrary.md or not) to welcome.htm for WelcomeFile, for better backward compatibility, then links to arbitrary.htm from other documentation files would also need to be updated. Suggestion 1: copy to welcome.htm rather than rename?

Question: header and footer for the .htm, as the .md will only be the content.

This relates to the kmp info.description field, which is also .md, although inline and without header and footer. This particular field also disables inline html, but the isolated .md files should allow inline html.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.