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

jsr.io showing garbage in Overview tab #881

Open
paulmillr opened this issue Jan 3, 2025 · 7 comments
Open

jsr.io showing garbage in Overview tab #881

paulmillr opened this issue Jan 3, 2025 · 7 comments

Comments

@paulmillr
Copy link

What am I doing wrong here? First, it doesn't contain contents of README. Second, it doesn't format code examples properly.

deno doc jsr:@scure/bip32 displays example correctly.

https://jsr.io/@scure/bip32, https://github.com/paulmillr/scure-bip32

@github-project-automation github-project-automation bot moved this to Needs Triage in JSR Jan 3, 2025
@EGAMAGZ
Copy link

EGAMAGZ commented Jan 3, 2025

In this case, to add examples you must write inside a code block, as if you were writing markdown, so that it is displayed correctly. It is explained a the botto, of the JSR documentation: https://jsr.io/docs/writing-docs

@paulmillr
Copy link
Author

This is violation of JSDOC, which did not require this for 10+ years.

@EGAMAGZ
Copy link

EGAMAGZ commented Jan 3, 2025

At least give an attempt to check if that's the solution. It might be a violation to JSDoc conventions, which can be solve opening an issue to suggest this

@paulmillr
Copy link
Author

That fixed it: https://jsr.io/@scure/[email protected]

@paulmillr
Copy link
Author

I would say bad syntax highlighting is less problematic than NOT displaying the README. Some error happens somewhere and it stops short of displaying README?

@paulmillr
Copy link
Author

In this example, syntax is highlightened correctly, but readme is still not there: https://jsr.io/@noble/[email protected]

@paulmillr
Copy link
Author

Here syntax is OK, readme is also OK. It's not clear how index.ts header differs from [email protected]

https://jsr.io/@scure/[email protected]

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

No branches or pull requests

2 participants