Problem/Motivation

I'm currently working on a project, where I like to parse my project's root README.md and show it to the sitebuilders. While researching if a comparable solution already exists, I stumbled across this project and saw, that it more or less does, what I had in my mind.

The only difference is, that I like to render the README.md of my project repository and provide it to the user.

Proposed resolution

While investigating, I saw, that the ReadmeManagerInterface is quite coupled to the use of modules (and not other folders). That makes it impossible to easily extend your classes, without rebuilding most of it again.

As a result I came up with a bit hacky approach, which can be used a proof of concept for an better integration. I will like to attach it here for further internal usage or when other might have the same needs.

CommentFileSizeAuthor
#2 readme-add_root_readme-2923675-2.patch2.81 KBszeidler

Comments

szeidler created an issue. See original summary.

szeidler’s picture

StatusFileSize
new2.81 KB

Here's the POC patch.

ikit-claw’s picture

Hi @szeidler are you still wanting this feature adding?

szeidler’s picture

It's up to you (or the other maintainers) to decide, if it makes sense to add it to the module. I wouldn't call it the most crucial feature to have :) But I'm using a patched version in a project, that had exactly that requirement.

ikit-claw’s picture

I'll have a look at it and consider adding it don't think the others particularly care right now. Thanks for your contribution.

ikit-claw’s picture

@szeidler I have added this to the dev branch now.

ikit-claw’s picture

Status: Active » Needs review
ikit-claw’s picture

Status: Needs review » Fixed

Closed fix no issues noticed so far with the patch

Status: Fixed » Closed (fixed)

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