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

be lenient with example titles' presence #24

Merged
merged 4 commits into from
Jun 19, 2019

Conversation

peterbe
Copy link
Contributor

@peterbe peterbe commented Jun 11, 2019

This isn't very deeply thought out but I think it might help a little.
With this change, you can render out .html files for every single "html" element. Nifty!

As of this change http://localhost:3000/docs/Web/HTML/Element/aside now works and make deployment-build also works.

@peterbe peterbe requested a review from wbamberg June 11, 2019 17:27
@peterbe
Copy link
Contributor Author

peterbe commented Jun 11, 2019

By the way, as of this change you can also open http://localhost:5000/docs/Web/HTML/Element/aside (note the port :5000 instead of :3000) and it's the SSR rendered full HTML page. Yay

@wbamberg
Copy link
Collaborator

I'm ambivalent about this. I am also keen to see the renderer being able to render more of our pages, and this is definitely one of the main points that needs to be addressed for that.

On the other hand, we are actively discussing how to represent examples here and it's very likely that this discussion will have downstream changes. So part of me thinks we should wait for that to resolve, then update the content, then update the renderer.

But I think this would be OK for now, except that it will break the heading hierarchy if the title is absent (because the source and result headings are H4). So I think we should change it so that if the title is absent then the source and result headings are H3.

Also won't this:

<RenderExample key={example.description.title + i} example={example} />  

...be weird if title is undefined?

Copy link
Collaborator

@wbamberg wbamberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@wbamberg wbamberg merged commit 0e8b0fe into master Jun 19, 2019
@peterbe peterbe deleted the be-lenient-with-example-titles-presence branch June 19, 2019 23:45
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

Successfully merging this pull request may close these issues.

2 participants