Library readme markdown support#21064
Open
dannon wants to merge 22 commits into
Open
Conversation
Member
|
That is such a clever idea - I love it. |
- Fix Vue watcher to track readme_raw properly - Use separate data property for rendered content - Remove unused backend rendering code - Add .markdown extension support
Moved all CSS from library-folder-table.css into LibraryFolder.vue as scoped styles. Better organization and keeps everything in one place.
Add DOMPurify sanitization to rendered markdown content from library README files. The markdown renderer doesn't sanitize HTML by default, which could allow malicious scripts in uploaded README files.
- Remove unused markdown import - Fix readme_raw default value to None instead of empty string to match schema - Update type hint to str | None for consistency
Implemented toggle button in toolbar with split-pane display (2:1 ratio) for README viewing, mirroring the workflow README pattern. README panel slides in from the right when toggled, showing content side-by-side with the library folder table. Table columns adjust responsively to fit the allocated space.
Previously README only appeared on pages where the file was listed. Now uses a targeted query to find README independently of pagination.
The button now shows disabled state with 'No README available' tooltip when there's no README content. The panel only displays when both the toggle is on and README content exists. Toggle state persists across folders so README automatically shows when navigating to folders that have one.
renderReadme was calling this.sanitize, which isn't defined in this component -- switch to the imported purify helper the rest of the file already uses for sanitization.
Move the func/select import to the top of the module instead of inside the index method, and drop the redundant 'r' mode on the README open().
Covers both the empty case (no readme_raw) and a folder containing a README.md markdown dataset surfaced through the folder contents metadata.
dannon
marked this pull request as ready for review
June 18, 2026 16:39
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Work from @tcollins2011 at GCC2025 Hackathon -- I rebased this and made a few tweaks.
How to test the changes?
(Select all options that apply)
License