Display another file as header or footer as documentation for files in web editor
Description
As a user I would like to be able to have another file rendered on the "Edit file" page to provide documentation to the viewer.
Consider an environment where many contributions can be made directly from the Gitlab web interface rather than from a CLI git tool. It would be nice to be able to display some other file either above or below the edit window to the viewer.
Proposal
- Render
<file>.md
or<file>.header.md
above the editor text box on the "Edit file" page if either exists in the repository - Render
<file>.footer.md
below the editor text box on the "Edit file" page if it exists in the repository - The rendered files should be bounded by hide/unide or windowshade type controls to minimize them
- The rendered files should support slug detection with a "read more" button
- The the source
.md
.header.md
or.footer.md
files should be hyperlinked in the header/footer.
Slug
In order to allow the author to limit the amount of text shown as a header or footer. The rendering engine should display only the content before the first horizontal rule in the markdown file. An "expand" or "read more" link would expand the windowshaded document or link to the source file directly.
# Puppetfile
This would be displayed as the header or footer for Puppetfile.
---
This would not...
~"feature proposal"
Edited by 🤖 GitLab Bot 🤖