Fix Markdown rendering within summary/detail #2059

axic · 2019-05-21T17:47:00Z

Tries to fix the rendering of https://eips.ethereum.org/EIPS/eip-1474

Idea from: gettalong/kramdown#155 (comment)

axic · 2019-05-21T17:57:38Z

This actually triggered two ERCs which have bad formatting:

- ./_site/EIPS/eip-1154.html
  *  171:14: ERROR: Unexpected end tag : dd (line 171)
  *  172:12: ERROR: Unexpected end tag : dd (line 172)
  *  173:10: ERROR: Unexpected end tag : dd (line 173)
  *  174:8: ERROR: Unexpected end tag : dd (line 174)
- ./_site/EIPS/eip-1620.html
  *  linking to internal hash #log-confirm-update that does not exist (line 228)
     <a href="#log-confirm-update">LogConfirmUpdate</a>
  *  linking to internal hash #log-create that does not exist (line 195)
     <a href="#log-create">LogCreate</a>
  *  linking to internal hash #log-execute-update that does not exist (line 230)
     <a href="#log-execute-update">LogExecuteUpdate</a>
  *  linking to internal hash #log-redeem that does not exist (line 217)
     <a href="#log-redeem">LogRedeem</a>
  *  linking to internal hash #log-revoke-update that does not exist (line 241)
     <a href="#log-revoke-update">LogRevokeUpdate</a>
  *  linking to internal hash #log-withdraw that does not exist (line 206)
     <a href="#log-withdraw">LogWithdraw</a>

axic · 2019-05-23T20:59:58Z

I've fixed some of these "issues" locally, but actually realised that for some reason (probably due to Gemfile.lock) the github-pages packages is stuck at 179, while the current release 198. I'm sure the new version could fix a lot of rendering problems as it brings in newer kramdown.

Arachnid · 2019-05-26T22:48:35Z

Do you want to pursue this PR further?

axic · 2019-05-26T23:20:43Z

Yes. Need to figure out how I can convince my bundler to update the versions.

This brings in fixes to kramdown.

…ndency

…mbedded markdown

eip-automerger · 2019-07-19T19:56:22Z

Hi! I'm a bot, and I wanted to automerge your PR, but couldn't because of the following issue(s):

File .gitignore is not an EIP
File .travis.yml is not an EIP
File Gemfile is not an EIP
File Gemfile.lock is not an EIP
File _config.yml is not an EIP
EIP 1057 requires approval from one of (@ifdefelse)
EIP 1123 requires approval from one of (@djrtwo, @pipermerriam, @njgheorghita, @gnidan)
EIP 1484 requires approval from one of (shanehampton1@gmail.com, andychorlian@gmail.com, anurag.angara@gmail.com, @NoahZinsmeister)
EIP 1620 requires approval from one of (hello@paulrberg.com, @PaulRBerg)

axic · 2019-07-19T20:07:29Z

_config.yml

+  # This is the default, but be explicit as some EIPs depend on it
+  auto_ids: true
+  # This is to ensure more determistic behaviour
+  auto_id_stripping: true


Link generation is explained here: https://kramdown.gettalong.org/converter/html.html#auto-ids

Newer version of kramdown changed the rules, hence the changes to existing EIPs. The htmlproofer check verifies that the links are pointing to existing headers.

axic · 2019-07-19T20:09:13Z

_config.yml

@@ -36,6 +36,12 @@ twitter:
 # Build settings
 markdown: kramdown
 theme: minima
+kramdown:
+  parse_block_html: false


Turned this to true means that markdown parsing is enabled within <details> blocks. However it is not working well. The closing HTML tags are not parsed.

This introduces problems with other EIPs which use the details block properly (820, 1820, etc.): only with a larger code snippet and not with embedded markdown.

The resolution is to change EIP-1474 instead, which was the culprit triggering this entire PR.

I can update EIP-1474 accordingly.

@bitpshr thanks! I already did in this PR.

axic · 2019-07-19T20:09:23Z

@Arachnid should be ready to merge.

axic · 2019-07-19T20:11:00Z

EIPS/eip-1123.md

@@ -1397,8 +1393,6 @@ The `name` field defines which compiler was used in compilation.
 </table>


-<div id="version-version-1"></div>


Kramdown generates proper links out the headers now, no need for these. If left here htmlproofer complains about duplicate IDs. Manually verified they point to the right header.

…mbedded markdown

axic · 2019-07-26T19:43:58Z

@Arachnid any comments on merging this?

axic · 2019-08-08T14:55:14Z

@Arachnid @nicksavers any objections merging this?

* Fix Markdown rendering within summary/detail * Add vendor to .gitignore * Remove duplicate github-pages entry from Gemfile * Require github-pages 198 This brings in fixes to kramdown. * Remove explicit jekyll version as github-pages brings it in as a dependency * Update bundler dependency tree * Fake bundler version * use Ruby 2.3.0 * Set sane defaults for kramdown * Fix links after kramdown update * Remove <details> formatting from EIP-1474 as it is not working with embedded markdown * Revert "Fix Markdown rendering within summary/detail" * Fix email in EIP-1812 * Remove <details> formatting from EIP-1620 as it is not working with embedded markdown

axic requested review from Arachnid and nicksavers May 21, 2019 17:51

axic added the meta label May 21, 2019

This was referenced May 21, 2019

Add EIP-1474 as a requirement to RPC ERCs #2058

Merged

Up-to-date JSON-RPC API spec #2053

Closed

axic force-pushed the jekyll-markdown branch 3 times, most recently from 013d9be to 62c17a5 Compare July 2, 2019 02:30

axic added 8 commits July 19, 2019 19:25

Add vendor to .gitignore

6d3a949

Remove duplicate github-pages entry from Gemfile

da23573

Require github-pages 198

c0c4007

This brings in fixes to kramdown.

Remove explicit jekyll version as github-pages brings it in as a depe…

daed711

…ndency

Update bundler dependency tree

b149e5a

Fix Markdown rendering within summary/detail

e9d9a36

Fake bundler version

9a504a9

use Ruby 2.3.0

9963540

axic force-pushed the jekyll-markdown branch from 7e8e2f0 to 9963540 Compare July 19, 2019 18:25

axic added 4 commits July 19, 2019 19:59

Set sane defaults for kramdown

895bd40

Fix links after kramdown update

9f6e2be

Remove <details> formatting from EIP-1474 as it is not working with e…

f6e8991

…mbedded markdown

Revert "Fix Markdown rendering within summary/detail"

aea35ac

Fix email in EIP-1812

5d5b6b8

axic commented Jul 19, 2019

View reviewed changes

Remove <details> formatting from EIP-1620 as it is not working with e…

9ddeadc

…mbedded markdown

danfinlay approved these changes Jul 24, 2019

View reviewed changes

pelle approved these changes Jul 25, 2019

View reviewed changes

bitpshr approved these changes Jul 26, 2019

View reviewed changes

Arachnid approved these changes Aug 8, 2019

View reviewed changes

Arachnid merged commit bba07b8 into ethereum:master Aug 8, 2019

axic deleted the jekyll-markdown branch August 8, 2019 22:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix Markdown rendering within summary/detail #2059

Fix Markdown rendering within summary/detail #2059

axic commented May 21, 2019 •

edited

Loading

axic commented May 21, 2019

axic commented May 23, 2019

Arachnid commented May 26, 2019

axic commented May 26, 2019

eip-automerger commented Jul 19, 2019 •

edited

Loading

axic Jul 19, 2019 •

edited

Loading

axic Jul 19, 2019

bitpshr Jul 19, 2019

axic Jul 19, 2019 •

edited

Loading

axic commented Jul 19, 2019

axic Jul 19, 2019

axic commented Jul 26, 2019

axic commented Aug 8, 2019

		@@ -1397,8 +1393,6 @@ The `name` field defines which compiler was used in compilation.
		</table>


		<div id="version-version-1"></div>

Fix Markdown rendering within summary/detail #2059

Fix Markdown rendering within summary/detail #2059

Conversation

axic commented May 21, 2019 • edited Loading

axic commented May 21, 2019

axic commented May 23, 2019

Arachnid commented May 26, 2019

axic commented May 26, 2019

eip-automerger commented Jul 19, 2019 • edited Loading

axic Jul 19, 2019 • edited Loading

Choose a reason for hiding this comment

axic Jul 19, 2019

Choose a reason for hiding this comment

bitpshr Jul 19, 2019

Choose a reason for hiding this comment

axic Jul 19, 2019 • edited Loading

Choose a reason for hiding this comment

axic commented Jul 19, 2019

axic Jul 19, 2019

Choose a reason for hiding this comment

axic commented Jul 26, 2019

axic commented Aug 8, 2019

axic commented May 21, 2019 •

edited

Loading

eip-automerger commented Jul 19, 2019 •

edited

Loading

axic Jul 19, 2019 •

edited

Loading

axic Jul 19, 2019 •

edited

Loading