grpc/grpc.github.io

Blog navigation assumes no headers will be present "above the fold"

Opened this issue · 8 comments

Noticed this looking at the blog index page today after the community meeting update was published. For small posts like that, it doesn't make sense to have a <!-- more --> section.

Agreed - this needs to be fixed. I have a work around for a section since without it, the headers get corrupted.

I have a solution that doesn't involve adding the <!-- more --> section

Nvm. I'll have to look into this some more. Looks like the solution you pushed resolved for now. Trying to understand what jekyll is doing under the hood that causes this

I think the <!--more--> (excerpt separator) section is less a workaround and more how Jekyll actually expects you to write blog posts - the idea is that you get snippets of blog posts on the blog landing page and then click on them to get the full post, not that the blog landing page has entire posts (which is what you get without the separator). This is from Jekyll's instructions on writing a post:

https://jekyllrb.com/docs/posts/#post-excerpts

TBH, I think consistently having the excerpts for all posts is a better experience for the user, rather than having some complete posts with headers and some where you have to click to read more.

Alternatively we can use bold text instead of headings. From the sounds of it though, we can probably close this as fixed then. I'll add the <!-- more --> syntax to my template.

We pretty much hit this every blog post.. or maybe I do. <!--more--> does not work with spaces in between, unlike a normal html comment, so this is fragile.

@LisaFC is there any good jekyll linter you are aware of? If we can identify one, it may be worthwhile to enable it as a presubmit hook.

Not that I'm aware of, no. :(

Markdown is essentially kind of fragile given how much it relies on whitespace and the fact that it isn't actually standardized....