Skip to content

Allow referencing markdown links from the repository root #4039

@vjpr

Description

@vjpr

🚀 Feature

Have you read the Contributing Guidelines on issues?

Yes

Motivation

In a monorepo setting with multiple docs plugins, you may want to link between two sites.

For example I write:

packages/lib1/docs/readme.md

See [shared template docs](/repos/live/packages/app-templates/chrome-extension/docs-shared/readme.md).

And I get this error:

warn Docs markdown link couldn't be resolved: (/repos/live/packages/app-templates/chrome-extension/docs-shared/readme.md) in /xxx/repos/live/packages/app-templates/chrome-extension/docs/readme.md for version current

In my IDE, I can cmd+click on the link

Pitch

Relative links would solve this but its painful to keep up to date.

Maybe allow a config option to control the linking behaviour.

Metadata

Metadata

Assignees

No one assigned

    Labels

    closed: wontfixA fix will bring significant overhead, or is out of scope (for feature requests)featureThis is not a bug or issue with Docusausus, per se. It is a feature request for the future.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions