Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support rendering markdown files besides README.md #709

Open
KyleJune opened this issue Sep 2, 2024 · 1 comment
Open

Support rendering markdown files besides README.md #709

KyleJune opened this issue Sep 2, 2024 · 1 comment
Labels
docs gen Related to the documentation generation feature New feature or request

Comments

@KyleJune
Copy link

KyleJune commented Sep 2, 2024

It's common for README.md files to link to other markdown files. On GitHub, when you click one of those links it will take you to a page with the markdown rendered instead of the source code for the markdown file. On JSR, those links take you to the source code for the markdown files.

You can see an example of this by clicking any of the links near the bottom of the overview for my package.

https://jsr.io/@udibo/react-app

@inverted-capital
Copy link

This problem is compounded further if the package is published out of a monorepo / workspace. What happens is the linked repository is the workspace root, and the links to the markdown docs are generated relative to that, not relative to the package subdirectory in that root.

The package markdown should render relative links that stay on the jsr site, and show the file in the files view, imo

@lucacasonato lucacasonato added feature New feature or request docs gen Related to the documentation generation labels Oct 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs gen Related to the documentation generation feature New feature or request
Projects
Status: Needs Triage
Development

No branches or pull requests

3 participants