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.

Sign up for GitHub

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

Jump to bottom

fix: broken link on icons readme page in patternhub #2935

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix: broken link on icons readme page in patternhub #2935

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/foundations/docs/Icons.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ You can add an icon before or after a tag, by adding an `data-` attribute to you

If you have custom icons and want to use them for foundations and/or in components, you need to generate a **woff2** file.

[More information](./CustomIcons.md)
[More information](./custom-icons)
Copy link
Member

@mfranzke mfranzke Jul 30, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this won't work if this documentation is opened via https://github.com/db-ui/mono/blob/fix-link-in-patternhubs-icons-readme-broken/packages/foundations/docs/Icons.md

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mfranzke and @nmerget

That's basically true. In the end, this also applies to all other internal links here: If links point to paths with the file extension .md, they work in Github, but not in Patternhub. And vice versa.

A possible solution would be to have links in the md files end with the appendix .md. However, when copying these files to Patternhub via node-script, remove .md from links.

What do you think?

Copy link
Member

@mfranzke mfranzke Aug 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mfranzke and @nmerget

That's basically true. In the end, this also applies to all other internal links here: If links point to paths with the file extension .md, they work in Github, but not in Patternhub. And vice versa.

A possible solution would be to have links in the md files end with the appendix .md. However, when copying these files to Patternhub via node-script, remove .md from links.

What do you think?

I agree with what you're suggesting. In either case we would need some kind of transformation of these links to another format. And as the codebase out of GitHub is displayed at github.com out of the box, but does get some kind of transformation for being displayed in "patternhub", we should rewrite the URL in the latter step / setup.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as aligned with @bruno-sch: the links within markdown need to be correct and during the transformation for GitHub Pages those links would need to get transformed as well to the resulting structure.

Loading