You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
(This is a tech debt clean-up issue from the legacy Jekyll docs site.)
The docs/index.md file currently contains a lot of HTML- complete with attributes and class names. This file should contain only (or at least predominantly) markdown syntax. We should remove as much of the HTML as possible and instead convert it to regular markdown.
There are 2 things to be aware of while cleaning up this markdown file:
The layout of the home page uses horizontal scrolling for the top section. This is not achievable with regular markdown.
The bottom sections each have a live code example that ties into the home.js template (see below).
The templates/home.js template makes this situation a little more complex, since it currently uses some of the inline HTML elements from index.md to mount examples (eg <div id="helloExample"></div>). It might be acceptable to leave only these mount nodes in the file and remove all else.
It might also be nice to break index down into a couple of files, although this would also require:
Moving home.js from templates to pages and creating a graphql query to load these files
Updating gatsby-node.js to ignore the files (so they aren't turned into standalone pages. (We have a similar check for the error decoder page.)
Making Home a page instead of a template would also provide a nice solution for the horizontal scrolling problem mentioned above.
Also, mountCodeExample currently does some really hacky stuff. Making Home a page instead of a template could help us move some of that hackiness out and simplify things like showing a placeholder while pre-loading Babel (#2).
Please feel free to chat with @bvaughn if you decide to pick up this issue.
I've added an "in-progress" label so that others will know not to start work on the issue. If you change your mind about the issue, no worries! Just let me know so that I can remove the label and free it up for someone else to claim.
Activity
yangshun commentedon Oct 9, 2017
@bvaughn I would like to take up this task
bvaughn commentedon Oct 9, 2017
This issue is all yours! 😄
I've added an "in-progress" label so that others will know not to start work on the issue. If you change your mind about the issue, no worries! Just let me know so that I can remove the label and free it up for someone else to claim.
Cheers!
bvaughn commentedon Oct 11, 2017
Note that PR #100 may have some impact on your work-in-progress @yangshun. Just an FYI.
I also updated the description to call out the hackiness in
mountCodeExamplemore explicitly.yangshun commentedon Oct 12, 2017
Got it. Thanks for the heads up!
bvaughn commentedon Nov 7, 2017
This issue has been resolved via #150 and some follow up commits. Thanks again to @yangshun for your help!
yangshun commentedon Nov 7, 2017
You're welcome! Sorry this took so long too 😓 Thanks for the follow up work (which made up the bulk of the PR actually 😂 )
bvaughn commentedon Nov 7, 2017
No problem 😁 I'm pretty happy with the resulting solution so yay for us
Translate Portals to pt-BR (reactjs#97)
docs(cn): translate content/docs/reference-test-renderer.md into Chin…