Skip to content

Support for symbolic linked .md files #11080

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

Open
1 of 2 tasks
felipecrs opened this issue Apr 8, 2025 · 0 comments
Open
1 of 2 tasks

Support for symbolic linked .md files #11080

felipecrs opened this issue Apr 8, 2025 · 0 comments
Labels
proposal This issue is a proposal, usually non-trivial change

Comments

@felipecrs
Copy link
Contributor

Have you read the Contributing Guidelines on issues?

Motivation

This issue is kind of a continuation from:

I have a repository with many helm charts, docker images, and whatnot. I like to keep a README.md for each of these little sub-projects, right inside each folder.

That's so when people open the directories in GitHub, they will have the README rendered.

And also, I'd like to show them in my documentation portal.

For now, I'm creating symbolic links to all these READMEs into my website/docs dir, so that they get parsed by Docusaurus too. For that to work, I need to use the WebPack resolve.symlinks: false trick.

And it works great, except it does not work when the Docusaurus project is installed with pnpm install (and also deno install, which works the same way as pnpm).

So, it would be great if Docusaurus had direct support for reading symlinked .md files.

Self-service

  • I'd be willing to do some initial work on this proposal myself.
@felipecrs felipecrs added proposal This issue is a proposal, usually non-trivial change status: needs triage This issue has not been triaged by maintainers labels Apr 8, 2025
@slorber slorber removed the status: needs triage This issue has not been triaged by maintainers label Apr 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
proposal This issue is a proposal, usually non-trivial change
Projects
None yet
Development

No branches or pull requests

2 participants