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

Need improvements to result when "make" fails #925

Closed
shaavan opened this issue Nov 9, 2022 · 2 comments
Closed

Need improvements to result when "make" fails #925

shaavan opened this issue Nov 9, 2022 · 2 comments

Comments

@shaavan
Copy link
Contributor

shaavan commented Nov 9, 2022

Providing non-ASCII characters as the title of a section can lead to the following error, which occurs when no successful anchor link can generate.

image

The issue is that in the presence of multiple errors of this kind, it's pretty hard to pinpoint the culprit for the error, making the debugging process unnecessarily complicated.

I tried to find a way to notify about the line number, which caused the issue, but it seems like we would need to modify the code for html-proofer to make this happen.

I want to discuss ways to solve this issue from our side or at least make the error less cryptic without being misleading.

@bitschmidty
Copy link
Contributor

Due to this issue with the auto-anchor plugin (#349) we recommend that you provide a comment with ASCII. I think you are doing that for your workarounds. I dont have a better plan right now other than putting those ASCII comments in to generate usable slugs.

https://github.com/bitcoinops/bitcoinops.github.io/blob/master/CONTRIBUTING.md

Due to #349 in the automatic anchoring process, some languages need HTML comments inserted into the header/bullet to ensure a unique anchor is generated. For example, see the comment in this Japanese newsletter.

If you have additional suggestions, let me know.

@bitschmidty
Copy link
Contributor

Im going to close this issue. There is a workaround for current translations and also discussion about a bigger move for the site in terms of Jekyll upgrade or a different software for generating the site. #1438

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

No branches or pull requests

2 participants