Merge pull request #476 from ethereum/better-docs

Better docs

doc/.prettierignore

@@ -0,0 +1,4 @@
+*.min.js
+*.html
+*.css
+*.json

doc/.prettierrc.js

@@ -0,0 +1,30 @@
+'use strict';
+// "schema": "https://raw.githubusercontent.com/SchemaStore/schemastore/master/src/schemas/json/prettierrc.json",
+// "$schema": "http://json.schemastore.org/prettierrc",
+module.exports = {
+  arrowParens: 'always',
+  bracketSpacing: true,
+  endOfLine: 'lf',
+  printWidth: 100,
+  proseWrap: 'never',
+  singleQuote: true,
+  tabWidth: 2,
+  trailingComma: 'all',
+  quoteProps: 'as-needed',
+  embeddedLanguageFormatting: 'auto',
+  semi: true,
+  overrides: [
+    {
+      files: '*.md',
+      options: {
+        parser: 'markdown',
+        printWidth: 80,
+        proseWrap: 'always',
+        tabWidth: 4,
+        useTabs: true,
+        singleQuote: false,
+        bracketSpacing: true,
+      },
+    },
+  ],
+};

doc/book.css

@@ -0,0 +1,13 @@
+table {
+    margin: 0 auto;
+    border-collapse: collapse;
+    width: 100%;
+}
+
+table td:first-child {
+    width: 15%;
+}
+
+table td:nth-child(2) {
+    width: 25%;
+}

doc/book.toml

@@ -1,6 +1,19 @@
 [book]
-authors = ["dxo"]
+authors = ["dxo", "msoos"]
 language = "en"
 multilingual = false
 src = "src"
 title = "hevm"
+
+
+[output.html]
+no-section-label = true
+additional-js = ["solidity.min.js"]
+additional-css = ["book.css"]
+git-repository-url = "https://github.com/ethereum/hevm"
+edit-url-template = "hhttps://github.com/ethereum/hevm/edit/main/{path}"
+
+git-repository-icon = "fa-github"
+
+[output.html.fold]
+enable = true

doc/cspell.json

@@ -0,0 +1,14 @@
+{
+    "cSpell.words": [
+        "Bufs",
+        "dapptools",
+        "endstates",
+        "Halmos",
+        "Hevm",
+        "Kontrol",
+        "preconfigured",
+        "reentrancy",
+        "returndata",
+        "txdata"
+    ]
+}