Skip to content

Commit

Permalink
feat: mdbook
Browse files Browse the repository at this point in the history
  • Loading branch information
@lidatong
lidatong committed Jan 13, 2024
1 parent afb4365 commit 58cc5fa
Show file tree
Hide file tree
Showing 74 changed files with 14,612 additions and 2 deletions.
2 changes: 0 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
Crypto Reading List
====================

_For a more friendly reading experience, we recommend navigating [here](https://jumpcrypto.github.io/crypto-reading-list)._

A curated list for getting up to speed on crypto and decentralized networks.

The content on the toplevel page contains what we consider essential reading.
Expand Down
30 changes: 30 additions & 0 deletions SUMMARY.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Summary

[Introduction](README.md)

- [Why](Why.md)
- [DeFi](DeFi.md)
- [NFT](NFT.md)
- [DAO](DAO.md)
- [L1](L1/README.md)
- [Bitcoin](L1/Bitcoin.md)
- [Ethereum](L1/Ethereum.md)
- [Avalanche](L1/Avalanche.md)
- [BSC](L1/BSC.md)
- [Cosmos](L1/Cosmos.md)
- [NEAR](L1/NEAR.md)
- [Polkadot](L1/Polkadot.md)
- [Polygon](L1/Polygon.md)
- [Solana](L1/Solana.md)
- [Terra](L1/Terra.md)
- [L2](L2.md)
- [TradingDynamics](TradingDynamics.md)
- [MEV](MEV.md)
- [Dev](Dev/README.md)
- [Solidity](Dev/Solidity.md)
- [Solana](Dev/SolanaProgramming.md)
- [Security](Dev/Security.md)
- [Tools](Tools.md)
- [Exercises](Exercises.md)
- [Other lists](OtherLists.md)
- [Researchers](Researchers.md)
2 changes: 2 additions & 0 deletions Why.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
Why crypto?
============

In addition to the list on the main page, we recommend:

* [Fat Protocol thesis](https://www.usv.com/writing/2016/08/fat-protocols/)
* oft-cited piece arguing for the value of network effects in blockchain infrastructure
17 changes: 17 additions & 0 deletions book.toml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[book]
title = "Crypto Reading List"
authors = ["Jump Crypto"]
description = "A curated list for getting up to speed on crypto and decentralized networks."
src = "."
language = "en"

[rust]
edition = "2021"

[build]
build-dir = "docs"
create-missing = false

[output.html]
git-repository-url = "https://github.com/jumpcrypto/crypto-reading-list"
site-url = "/crypto-reading-list/"
7 changes: 7 additions & 0 deletions docs/.gitignore
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.idea/
*.sw[po]
/.cargo
/dist
/node_modules
.env
*.ipynb
1 change: 1 addition & 0 deletions docs/.nojekyll
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This file makes sure that Github Pages doesn't process mdBook's output.
170 changes: 170 additions & 0 deletions docs/404.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
<!DOCTYPE HTML>
<html lang="en" class="sidebar-visible no-js light">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title></title>
<base href="/crypto-reading-list/">
<!-- Custom HTML head -->
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<meta name="description" content="A curated list for getting up to speed on crypto and decentralized networks.">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff" />

<link rel="icon" href="favicon.svg">
<link rel="shortcut icon" href="favicon.png">
<link rel="stylesheet" href="css/variables.css">
<link rel="stylesheet" href="css/general.css">
<link rel="stylesheet" href="css/chrome.css">
<link rel="stylesheet" href="css/print.css" media="print">
<!-- Fonts -->
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
<link rel="stylesheet" href="fonts/fonts.css">
<!-- Highlight.js Stylesheets -->
<link rel="stylesheet" href="highlight.css">
<link rel="stylesheet" href="tomorrow-night.css">
<link rel="stylesheet" href="ayu-highlight.css">

<!-- Custom theme stylesheets -->
</head>
<body>
<!-- Provide site root to javascript -->
<script type="text/javascript">
var path_to_root = "";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
</script>

<!-- Work around some values being stored in localStorage wrapped in quotes -->
<script type="text/javascript">
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');

if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}

if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
</script>

<!-- Set the theme before any content is loaded, prevents flash -->
<script type="text/javascript">
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('no-js')
html.classList.remove('light')
html.classList.add(theme);
html.classList.add('js');
</script>

<!-- Hide / unhide sidebar before it is displayed -->
<script type="text/javascript">
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
</script>

<nav id="sidebar" class="sidebar" aria-label="Table of contents">
<div class="sidebar-scrollbox">
<ol class="chapter"><li class="chapter-item expanded affix "><a href="index.html">Introduction</a></li><li class="chapter-item expanded "><a href="Why.html"><strong aria-hidden="true">1.</strong> Why</a></li><li class="chapter-item expanded "><a href="DeFi.html"><strong aria-hidden="true">2.</strong> DeFi</a></li><li class="chapter-item expanded "><a href="NFT.html"><strong aria-hidden="true">3.</strong> NFT</a></li><li class="chapter-item expanded "><a href="DAO.html"><strong aria-hidden="true">4.</strong> DAO</a></li><li class="chapter-item expanded "><a href="L1/index.html"><strong aria-hidden="true">5.</strong> L1</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="L1/Bitcoin.html"><strong aria-hidden="true">5.1.</strong> Bitcoin</a></li><li class="chapter-item expanded "><a href="L1/Ethereum.html"><strong aria-hidden="true">5.2.</strong> Ethereum</a></li><li class="chapter-item expanded "><a href="L1/Avalanche.html"><strong aria-hidden="true">5.3.</strong> Avalanche</a></li><li class="chapter-item expanded "><a href="L1/BSC.html"><strong aria-hidden="true">5.4.</strong> BSC</a></li><li class="chapter-item expanded "><a href="L1/Cosmos.html"><strong aria-hidden="true">5.5.</strong> Cosmos</a></li><li class="chapter-item expanded "><a href="L1/NEAR.html"><strong aria-hidden="true">5.6.</strong> NEAR</a></li><li class="chapter-item expanded "><a href="L1/Polkadot.html"><strong aria-hidden="true">5.7.</strong> Polkadot</a></li><li class="chapter-item expanded "><a href="L1/Polygon.html"><strong aria-hidden="true">5.8.</strong> Polygon</a></li><li class="chapter-item expanded "><a href="L1/Solana.html"><strong aria-hidden="true">5.9.</strong> Solana</a></li><li class="chapter-item expanded "><a href="L1/Terra.html"><strong aria-hidden="true">5.10.</strong> Terra</a></li></ol></li><li class="chapter-item expanded "><a href="L2.html"><strong aria-hidden="true">6.</strong> L2</a></li><li class="chapter-item expanded "><a href="TradingDynamics.html"><strong aria-hidden="true">7.</strong> TradingDynamics</a></li><li class="chapter-item expanded "><a href="MEV.html"><strong aria-hidden="true">8.</strong> MEV</a></li><li class="chapter-item expanded "><a href="Dev/index.html"><strong aria-hidden="true">9.</strong> Dev</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="Dev/Solidity.html"><strong aria-hidden="true">9.1.</strong> Solidity</a></li><li class="chapter-item expanded "><a href="Dev/SolanaProgramming.html"><strong aria-hidden="true">9.2.</strong> Solana</a></li><li class="chapter-item expanded "><a href="Dev/Security.html"><strong aria-hidden="true">9.3.</strong> Security</a></li></ol></li><li class="chapter-item expanded "><a href="Tools.html"><strong aria-hidden="true">10.</strong> Tools</a></li><li class="chapter-item expanded "><a href="Exercises.html"><strong aria-hidden="true">11.</strong> Exercises</a></li><li class="chapter-item expanded "><a href="OtherLists.html"><strong aria-hidden="true">12.</strong> Other lists</a></li><li class="chapter-item expanded "><a href="Researchers.html"><strong aria-hidden="true">13.</strong> Researchers</a></li></ol>
</div>
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
</nav>

<div id="page-wrapper" class="page-wrapper">

<div class="page">
<div id="menu-bar-hover-placeholder"></div>
<div id="menu-bar" class="menu-bar sticky bordered">
<div class="left-buttons">
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
<i class="fa fa-bars"></i>
</button>
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
<i class="fa fa-paint-brush"></i>
</button>
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
</ul>
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
<i class="fa fa-search"></i>
</button>
</div>

<h1 class="menu-title">Crypto Reading List</h1>

<div class="right-buttons">
<a href="print.html" title="Print this book" aria-label="Print this book">
<i id="print-button" class="fa fa-print"></i>
</a>
<a href="https://github.com/jumpcrypto/crypto-reading-list" title="Git repository" aria-label="Git repository">
<i id="git-repository-button" class="fa fa-github"></i>
</a>
</div>
</div>

<div id="search-wrapper" class="hidden">
<form id="searchbar-outer" class="searchbar-outer">
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
</form>
<div id="searchresults-outer" class="searchresults-outer hidden">
<div id="searchresults-header" class="searchresults-header"></div>
<ul id="searchresults">
</ul>
</div>
</div>
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
<script type="text/javascript">
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
</script>

<div id="content" class="content">
<main>
<h1 id="document-not-found-404"><a class="header" href="#document-not-found-404">Document not found (404)</a></h1>
<p>This URL is invalid, sorry. Please use the navigation bar or search to continue.</p>

</main>

<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
<div style="clear: both"></div>
</nav>
</div>
</div>

<nav class="nav-wide-wrapper" aria-label="Page navigation">
</nav>

</div>

<script type="text/javascript">
window.playground_copyable = true;
</script>
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
<script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
<script src="highlight.js" type="text/javascript" charset="utf-8"></script>
<script src="book.js" type="text/javascript" charset="utf-8"></script>

<!-- Custom JS scripts -->
</body>
</html>
Loading

0 comments on commit 58cc5fa

Please sign in to comment.