Display README.md from docs/, .github/, or other (.gitea/ ?) #2552

Closed
opened 2025-11-02 04:40:10 -06:00 by GiteaMirror · 3 comments
Owner

Originally created by @johnstonjs on GitHub (Nov 21, 2018).

  • Gitea version (or commit ref): 1.5.3
  • Git version: 2.9.3
  • Operating system: Various
  • Database (use [x]):
    • PostgreSQL
    • MySQL
    • MSSQL
    • SQLite
  • Can you reproduce the bug at https://try.gitea.io:
    • Yes (provide example URL)
    • No
    • Not relevant
  • Log gist: N/A

Description

First, thank you for making such a fantastic tool!

GitHub has an ability to display a README.md file not in the repository's root, as long as it's in either docs/ or .github/. The feature is documented here.

Suggestion

I'd find it useful to have a similar capability for gitea, replicating this capability of GitHub. Perhaps we could even have it read another folder, like /.gitea.

Originally created by @johnstonjs on GitHub (Nov 21, 2018). - Gitea version (or commit ref): 1.5.3 - Git version: 2.9.3 - Operating system: Various - Database (use `[x]`): - [ ] PostgreSQL - [X] MySQL - [ ] MSSQL - [ ] SQLite - Can you reproduce the bug at https://try.gitea.io: - [ ] Yes (provide example URL) - [ ] No - [X] Not relevant - Log gist: N/A ## Description First, thank you for making such a fantastic tool! GitHub has an ability to display a _README.md_ file not in the repository's root, as long as it's in either docs/ or .github/. The feature is [documented here](https://help.github.com/articles/about-readmes/). ## Suggestion I'd find it useful to have a similar capability for gitea, replicating this capability of GitHub. Perhaps we could even have it read another folder, like /.gitea.
GiteaMirror added the issue/confirmedtype/enhancement labels 2025-11-02 04:40:10 -06:00
Author
Owner

@stale[bot] commented on GitHub (Jan 20, 2019):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs during the next 2 weeks. Thank you for your contributions.

@stale[bot] commented on GitHub (Jan 20, 2019): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs during the next 2 weeks. Thank you for your contributions.
Author
Owner

@stale[bot] commented on GitHub (Feb 19, 2019):

This issue has been automatically closed because of inactivity. You can re-open it if needed.

@stale[bot] commented on GitHub (Feb 19, 2019): This issue has been automatically closed because of inactivity. You can re-open it if needed.
Author
Owner

@pinpox commented on GitHub (May 5, 2019):

I would also be interested in this. More specifically it would be nice to be able to specify a file directly in an arbitrary path of the repo

@pinpox commented on GitHub (May 5, 2019): I would also be interested in this. More specifically it would be nice to be able to specify a file directly in an arbitrary path of the repo
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/gitea#2552