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

Rework GitHub links as Docusaurus links with processing pass in builder #3

Open
razvand opened this issue Mar 13, 2023 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@razvand
Copy link

razvand commented Mar 13, 2023

Currently, links in GitHub, such as the one here - pointing to Application Interaction chapter, don't work with Docusaurus. See the rendered page here - the link points to a Page Not Found link.

The links should also be made to work on Docusaurus. As I discussed with @teodutu, the best way is for the builder to feature a processing pass that replaces GitHub links with correct links in Docusaurus.

@razvand razvand added the enhancement New feature or request label Mar 13, 2023
@razvand razvand changed the title Rework GitHub links as Docusaurus links as processing pass in builder Rework GitHub links as Docusaurus links with processing pass in builder Mar 13, 2023
@VladNastase
Copy link
Collaborator

I think we have discussed this before. Current version can resolve links to files, because the docusaurus plugin is aware of what files are copied where. This is a bit more difficult for concepts like chapters, where the plugin is not aware of some files (because they were generated - see Lab or Lecture chapters in the operating-systems repo).

I currently do not see a solution that does not involve manually specifying each link to be resolved (or using absolute links in the content with the protocol, domain etc. which is just as tedious and non-scalable).

You have suggested having a plugin that behaves like sed. While possibly a good addition to the builder plugins, I do not see how for this use case it is not the same as manually specifying what link to replace with what. Can you elaborate on that?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants