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.
| Comment | File | Size | Author |
|---|---|---|---|
| #2 | readme-add_root_readme-2923675-2.patch | 2.81 KB | szeidler |
Comments
Comment #2
szeidler commentedHere's the POC patch.
Comment #3
ikit-claw commentedHi @szeidler are you still wanting this feature adding?
Comment #4
szeidler commentedIt'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.
Comment #5
ikit-claw commentedI'll have a look at it and consider adding it don't think the others particularly care right now. Thanks for your contribution.
Comment #6
ikit-claw commented@szeidler I have added this to the dev branch now.
Comment #7
ikit-claw commentedComment #8
ikit-claw commentedClosed fix no issues noticed so far with the patch