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

Spacing on the package list #72

Open
JessMK opened this issue Nov 12, 2024 · 3 comments
Open

Spacing on the package list #72

JessMK opened this issue Nov 12, 2024 · 3 comments
Assignees

Comments

@JessMK
Copy link
Collaborator

JessMK commented Nov 12, 2024

Please help correct the spacing within the package list, between package 7 and 8 and beyond, thank you!

@arilamstein
Copy link
Collaborator

I just started looking into this and while I can reproduce the error on the main site in my browser, I cannot reproduce it locally. As an FYI, here is what I see in both Chrome and Safari when I view https://rconsortium.github.io/censusguide/:

problem

However, when I view the markdown preview in VS Code the spacing is consistent between all the points:

Screenshot 2024-11-21 at 9 38 20 AM

If you look at the markdown/code itself, you'll see a few things. The first is that the code for item 7 is pretty complicated. So there's a possibility that it contains a syntax error of some kind, and that this is resulting in the formatting error we see. Sometimes browsers are inconsistent in how they handle these errors. If you look at how VS Code is highlighting the syntax for all points, you'll see that Item 7 is styled differently, so this leads me to think that this is the issue. However, another point is that all the items above 7 have a newline between them, but the items below 8 do not. And that could be the issue as well.

Screenshot 2024-11-21 at 9 40 21 AM

Since I can't reproduce the issue locally, my options are to find a markdown validator of some kind and run it locally and/or experiment on main. I'm not sure which I'll do, but wanted to document my thought process before doing anything.

@arilamstein
Copy link
Collaborator

Adding newlines after each item fixed the issue for everything except the space between items 7 and 8. At some level this does not surprise me because the specific formatting is very niche: An ordered list where one of the items contains (and terminates with) an ordered list.

It is possible that rearranging the text of this item so that it doesn't end in a list item will solve this problem. A good candidate for that is this sentence: "The ipumsr package also provides functions for creating data extracts and browsing metadata programmatically via the IPUMS API."

arilamstein added a commit that referenced this issue Nov 21, 2024
…item. Hopefully this fixes the remaining issue in #72. But I won't know until I deploy it, as I cannot reproduce the issue on my local machine.
@arilamstein arilamstein reopened this Nov 21, 2024
@arilamstein
Copy link
Collaborator

It looks like that solved it. I'm now seeing spacing between items 7 and 8. @JessMK Can you please take a look at the guide in your browser, and see if you consider this issue now solved? If so, please close this issue.

Screenshot 2024-11-21 at 10 22 39 AM

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