chore(website): improve markdown rendering #463
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Current md rendering involves a small blinking because the md is displayed first in a <pre> tag, and then it is replaced by the html transformed by the marked.js library. The change ensures the <pre> tag is hidden by default, which removes the blinking effect. To be compliant with browser that doesn't have javascript enabled, a <noscript> tag has also been added that override the <pre> tag display. So when javascript is not enabled, the <pre> is visible. Because the mailchimp form was inside the <pre> tag, it was not rendered as a form when JS was disabled, only the html tags were visible. To fix that I moved the mailchimp form outside the <pre>.
zivkovicmilos
approved these changes
Jan 19, 2023
moul
approved these changes
Jan 19, 2023
|
@moul There's this golang lib https://github.com/yuin/goldmark that allows to extend markdown easily, I experienced it a little bit for the CLI documentation. That implies to process the markdown server side rather than client side like it is today, but I assume this is not a problem, right ? |
harry-hov
pushed a commit
to harry-hov/gno
that referenced
this pull request
Jan 27, 2023
chore(website): improve md rendering Current md rendering involves a small blinking because the md is displayed first in a <pre> tag, and then it is replaced by the html transformed by the marked.js library. The change ensures the <pre> tag is hidden by default, which removes the blinking effect. To be compliant with browser that doesn't have javascript enabled, a <noscript> tag has also been added that override the <pre> tag display. So when javascript is not enabled, the <pre> is visible. Because the mailchimp form was inside the <pre> tag, it was not rendered as a form when JS was disabled, only the html tags were visible. To fix that I moved the mailchimp form outside the <pre>.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Current md rendering involves a small blinking because the md is displayed first in a
<pre>tag, and then it is replaced by the html transformed by the marked.js library. The change ensures the<pre>tag is hidden by default, which removes the blinking effect.To be compliant with browser that doesn't have javascript enabled, a
<noscript>tag has also been added, to override the<pre>tag display. So when javascript is not enabled, the<pre>is visible.Because the mailchimp form was inside the
<pre>tag, it was not rendered as a form when JS was disabled, only the html tags were visible. To fix that I moved the mailchimp form outside the<pre>.How has this been tested?
gnolandandwebsitebinary, and visit http://localhost:8888.javascriptand select theDisable Javascriptoption, then refresh the page. Same operation to re-enable it.