Improve mdbook build process, eliminate nodejs deps

ethereum / hevm

symbolic EVM evaluator

https://hevm.dev

GNU Affero General Public License v3.0

223 stars 45 forks source link

Improve mdbook build process, eliminate nodejs deps #477

Closed sambacha closed 1 month ago

sambacha commented 4 months ago

Description

Eliminate the need for highlightjs and parcel build process by using mdbook and embedding the syntax minified code.

[output.html]
no-section-label = true
additional-js = ["solidity.min.js"]
additional-css = ["book.css"]

You can cherry-pick only these changes if you want, I started going a bit overboard after that.

added spelling dictionary of hevm/evm specific jargon
format markdown files
minor spelling fixes
added a table for comparison section in overview
extracted some of the solidity code examples into a separate folder

Checklist

[ ] tested locally
[ ] added automated tests
[x] updated the docs
[ ] updated the changelog

Result

You can check out the built site here FYI: https://manifoldfinance.github.io/hevm/

msooseth commented 4 months ago

Hey,

NICE! Have you seen https://github.com/ethereum/hevm/pull/476 ? I think some things here would conflict with that. I am trying to re-write the docs as explained in the issue here: https://github.com/ethereum/hevm/issues/430 and the PR linked. Do you wanna do a PR to that PR? Or how should we do this?

msooseth commented 4 months ago

How about cutting this into two changes? One change would be the update to the JSON, JS, etc that I'd merge immediately. The other change maybe you can rebase on top of my PR that is a more extensive rewrite of the docs? Your changes look interesting, and I think it'd be nice to rebase them on top of th. What do you think?

msooseth commented 4 months ago

Yay, I think I managed to merge most of your work on top of my changes! Thank you Sam! I'll check more thoroughly to see how if i missed something -- I still need to link your .sol files. I really-really love the table you created, so nice! It's good to hear from you and to see your work, so nice! Thanks so much!

Mate

msooseth commented 4 months ago

OK, I think I merged all your changes into: https://github.com/ethereum/hevm/pull/476 Can you maybe check and then close this request?

msooseth commented 1 month ago

Closing, as all requested changes have been merged :) Thanks again, was very helpful!