With this patch, README files are shown parsed through the markdown filter, if you have it installed. It adds a link to switch to plaintext when that is preferable, but defaults to markdown.

Also included is a bit of code to redirect to the only item in a list when looking at a module's help files.

CommentFileSizeAuthor
#4 advanced_help-parse_markdown-1405734-4.patch3.04 KBgisle
advanced_help-markdown_feature.patch1.41 KBRobin Millette

Comments

helior’s picture

helior commented

#1649588: Support Input Filters is attempting to achieve a very similar request in a more generic way. I'm reluctant to mark this as a duplicate, however, since it does not yet interpret README.md files as markdown. I'm just commenting here in case this interested you.

Robin Millette’s picture

Robin Millette commented

I think we can close this issue and I can help will the more general solution.

Just noticed #1556208: Add a hook to allow for different renderings of the README files for the Module Instructions module. I'm going to let them know about this issue.

gisle’s picture

gisle
he/him
Primary language Norwegian Bokmål
Location Norway
commented
Issue summary: View changes
Parent issue: » #1649588: Support Input Filters

The attempt to implement a similar feature in the Module Instructions module (#1556208: Add a hook to allow for different renderings of the README files) is so far not in a shape that is useable.

gisle’s picture

gisle
he/him
Primary language Norwegian Bokmål
Location Norway
commented
Version: 7.x-1.0 » 7.x-1.x-dev
StatusFileSize
new advanced_help-parse_markdown-1405734-4.patch3.04 KB

I really want to see this fixed, but could not use the previous patch. Since markdown files should be named README.md, we need to discover that as well, and check against xss.

The css for advanced_help code code made it a synonym for advanced_help pre and a block element. This breaks with the markdown filter and even with the example provided (security.html and history.html) where the code tag is clearly intended to be displayed inline. I've therefore removed the class.

The patch should be applied against the current dev snapshot ee42b700.

Please review the attached patch!

  • gisle committed 4abfa35 on 7.x-1.x 
    Issue #1405734 by gisle: Output READMEs as parsed Markdown

  • gisle committed 9226b94 on 
    Issue #1405734 by gisle: Output READMEs as parsed Markdown
gisle’s picture

gisle
he/him
Primary language Norwegian Bokmål
Location Norway
commented
Version: 7.x-1.x-dev » 7.x-1.2
Status: Needs review » Fixed

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.