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

Confusing link-external-filter example #10780

Open
soxofaan opened this issue Sep 12, 2024 · 5 comments · May be fixed by quarto-dev/quarto-web#1332 or #10806
Open

Confusing link-external-filter example #10780

soxofaan opened this issue Sep 12, 2024 · 5 comments · May be fixed by quarto-dev/quarto-web#1332 or #10806
Assignees
@mcanouil
Labels
documentation Doc improvements & quarto-web

Comments

@soxofaan
Copy link

What would you like to do?

Report an issue on quarto.org

Description

The example for the link-external-filter config is a bit confusing:

For example
^(?:http:|https:)\/\/www\.quarto\.org\/custom
will treat links that start with http://www.quarto.org as internal links

what is that custom doing in the example regex? Is that part of the regex (meaning that it has to be part of the link to be considered internal)? Or is that a special syntax for something?
@soxofaan soxofaan added the documentation Doc improvements & quarto-web label Sep 12, 2024
@soxofaan
Copy link
Author

comes from here I think:
https://github.com/quarto-dev/quarto-web/blob/main/docs/output-formats/html-basics.qmd#L336-L340

and apparently mentioned here too:
https://github.com/quarto-dev/quarto-web/blob/1d47eb81f05ec4b6c48864971a392ef677418eaa/docs/reference/formats/html.json#L444-L445

@soxofaan soxofaan mentioned this issue Sep 12, 2024
Closed
@cscheid
Copy link
Collaborator

cscheid commented Sep 12, 2024

I don't think this needs changing. The confusion can be solved by experimenting with the option, and understanding regexes are necessary to using them.

@cscheid cscheid closed this as not planned Won't fix, can't repro, duplicate, stale Sep 12, 2024
@soxofaan
Copy link
Author

I guess I should have expressed this problem less vague.

There is a bug in the documentation, it currently says:

^(?:http:|https:)\/\/www\.quarto\.org\/custom
will treat links that start with http://www.quarto.org/ as internal links

Which is wrong: http://www.quarto.org/foo starts with http://www.quarto.org/ but it will not be caught by the regex

I guess the docs should be changed to

^(?:http:|https:)\/\/www\.quarto\.org\/
will treat links that start with http://www.quarto.org/ as internal links

or to

^(?:http:|https:)\/\/www\.quarto\.org\/custom
will treat links that start with http://www.quarto.org/custom as internal links

@cscheid
Copy link
Collaborator

cscheid commented Sep 13, 2024

I gotcha. Can you make a PR?

@cscheid cscheid reopened this Sep 13, 2024
@mcanouil mcanouil linked a pull request Sep 15, 2024 that will close this issue
Open
@mcanouil
Copy link
Collaborator

I made the PR:

@mcanouil mcanouil self-assigned this Sep 16, 2024
@mcanouil mcanouil linked a pull request Sep 16, 2024 that will close this issue
Open
mcanouil added a commit to mcanouil/quarto-cli that referenced this issue Sep 16, 2024
@mcanouil
fix: Confusing link-external-filter example
8657daa 
Fixes quarto-dev#10780
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mcanouil mcanouil

Labels
documentation Doc improvements & quarto-web
Projects
None yet
Milestone
No milestone
3 participants
@soxofaan @cscheid @mcanouil