Skip to content

Commit bacbb0e

Browse files
committed
Start template
1 parent c2b01f4 commit bacbb0e

File tree

85 files changed

+13851
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+13851
-1
lines changed

.github/workflows/mdbook.yml

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Sample workflow for building and deploying a mdBook site to GitHub Pages
2+
#
3+
# To get started with mdBook see: https://rust-lang.github.io/mdBook/index.html
4+
#
5+
name: Deploy mdBook site to Pages
6+
7+
on:
8+
# Runs on pushes targeting the default branch
9+
push:
10+
branches: ["main"]
11+
12+
# Allows you to run this workflow manually from the Actions tab
13+
workflow_dispatch:
14+
15+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
16+
permissions:
17+
contents: read
18+
pages: write
19+
id-token: write
20+
21+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
22+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
23+
concurrency:
24+
group: "pages"
25+
cancel-in-progress: false
26+
27+
jobs:
28+
# Build job
29+
build:
30+
runs-on: ubuntu-latest
31+
env:
32+
MDBOOK_VERSION: 0.4.36
33+
steps:
34+
- uses: actions/checkout@v4
35+
- name: Install mdBook
36+
run: |
37+
curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
38+
rustup update
39+
cargo install --version ${MDBOOK_VERSION} mdbook
40+
- name: Setup Pages
41+
id: pages
42+
uses: actions/configure-pages@v5
43+
- name: Build with mdBook
44+
run: mdbook build
45+
- name: Upload artifact
46+
uses: actions/upload-pages-artifact@v3
47+
with:
48+
path: ./book
49+
50+
# Deployment job
51+
deploy:
52+
environment:
53+
name: github-pages
54+
url: ${{ steps.deployment.outputs.page_url }}
55+
runs-on: ubuntu-latest
56+
needs: build
57+
steps:
58+
- name: Deploy to GitHub Pages
59+
id: deployment
60+
uses: actions/deploy-pages@v4

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,34 @@
1-
# docs-mdbook
1+
# fluent-mdbook-test
2+
3+
## GitHub Pages Hosted Link
4+
5+
https://fluentlabs-xyz.github.io/docs-mdbook/
6+
7+
## Install mdbook
8+
9+
```shell
10+
cargo install mdbook
11+
```
12+
13+
## Create new template
14+
15+
```shell
16+
mdbook init
17+
```
18+
19+
## Test locally with mdbook
20+
21+
```shell
22+
mdbook serve
23+
```
24+
25+
## View local mdbook test serve in web browser
26+
27+
```
28+
localhost:3000
29+
```
30+
31+
## Foundry book reference
32+
33+
https://github.com/foundry-rs/book
34+

book.toml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[book]
2+
authors = ["MarcusWentz"]
3+
language = "en"
4+
multilingual = false
5+
src = "src"
6+
title = "⚙️ fluent ⚙️"
7+
8+
[output.html]
9+
git-repository-url = "https://github.com/fluentlabs-xyz/docs-mdbook"
10+
edit-url-template = "https://github.com/fluentlabs-xyz/docs-mdbook/edit/main/src/README.md"
11+
additional-js = ["src/static/solidity.min.js"]

book/.nojekyll

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This file makes sure that Github Pages doesn't process mdBook's output.

book/404.html

Lines changed: 217 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,217 @@
1+
<!DOCTYPE HTML>
2+
<html lang="en" class="light sidebar-visible" dir="ltr">
3+
<head>
4+
<!-- Book generated using mdBook -->
5+
<meta charset="UTF-8">
6+
<title>Page not found - ⚙️ fluent ⚙️</title>
7+
<base href="/">
8+
9+
10+
<!-- Custom HTML head -->
11+
12+
<meta name="description" content="">
13+
<meta name="viewport" content="width=device-width, initial-scale=1">
14+
<meta name="theme-color" content="#ffffff">
15+
16+
<link rel="icon" href="favicon.svg">
17+
<link rel="shortcut icon" href="favicon.png">
18+
<link rel="stylesheet" href="css/variables.css">
19+
<link rel="stylesheet" href="css/general.css">
20+
<link rel="stylesheet" href="css/chrome.css">
21+
<link rel="stylesheet" href="css/print.css" media="print">
22+
23+
<!-- Fonts -->
24+
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
25+
<link rel="stylesheet" href="fonts/fonts.css">
26+
27+
<!-- Highlight.js Stylesheets -->
28+
<link rel="stylesheet" href="highlight.css">
29+
<link rel="stylesheet" href="tomorrow-night.css">
30+
<link rel="stylesheet" href="ayu-highlight.css">
31+
32+
<!-- Custom theme stylesheets -->
33+
34+
35+
<!-- Provide site root to javascript -->
36+
<script>
37+
var path_to_root = "";
38+
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
39+
</script>
40+
<!-- Start loading toc.js asap -->
41+
<script src="toc.js"></script>
42+
</head>
43+
<body>
44+
<div id="body-container">
45+
<!-- Work around some values being stored in localStorage wrapped in quotes -->
46+
<script>
47+
try {
48+
var theme = localStorage.getItem('mdbook-theme');
49+
var sidebar = localStorage.getItem('mdbook-sidebar');
50+
51+
if (theme.startsWith('"') && theme.endsWith('"')) {
52+
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
53+
}
54+
55+
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
56+
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
57+
}
58+
} catch (e) { }
59+
</script>
60+
61+
<!-- Set the theme before any content is loaded, prevents flash -->
62+
<script>
63+
var theme;
64+
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
65+
if (theme === null || theme === undefined) { theme = default_theme; }
66+
const html = document.documentElement;
67+
html.classList.remove('light')
68+
html.classList.add(theme);
69+
html.classList.add("js");
70+
</script>
71+
72+
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
73+
74+
<!-- Hide / unhide sidebar before it is displayed -->
75+
<script>
76+
var sidebar = null;
77+
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
78+
if (document.body.clientWidth >= 1080) {
79+
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
80+
sidebar = sidebar || 'visible';
81+
} else {
82+
sidebar = 'hidden';
83+
}
84+
sidebar_toggle.checked = sidebar === 'visible';
85+
html.classList.remove('sidebar-visible');
86+
html.classList.add("sidebar-" + sidebar);
87+
</script>
88+
89+
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
90+
<!-- populated by js -->
91+
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
92+
<noscript>
93+
<iframe class="sidebar-iframe-outer" src="toc.html"></iframe>
94+
</noscript>
95+
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
96+
<div class="sidebar-resize-indicator"></div>
97+
</div>
98+
</nav>
99+
100+
<div id="page-wrapper" class="page-wrapper">
101+
102+
<div class="page">
103+
<div id="menu-bar-hover-placeholder"></div>
104+
<div id="menu-bar" class="menu-bar sticky">
105+
<div class="left-buttons">
106+
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
107+
<i class="fa fa-bars"></i>
108+
</label>
109+
<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">
110+
<i class="fa fa-paint-brush"></i>
111+
</button>
112+
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
113+
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
114+
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
115+
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
116+
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
117+
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
118+
</ul>
119+
<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">
120+
<i class="fa fa-search"></i>
121+
</button>
122+
</div>
123+
124+
<h1 class="menu-title">⚙️ fluent ⚙️</h1>
125+
126+
<div class="right-buttons">
127+
<a href="print.html" title="Print this book" aria-label="Print this book">
128+
<i id="print-button" class="fa fa-print"></i>
129+
</a>
130+
<a href="https://github.com/MarcusWentz/fluent-mdbook-test" title="Git repository" aria-label="Git repository">
131+
<i id="git-repository-button" class="fa fa-github"></i>
132+
</a>
133+
134+
</div>
135+
</div>
136+
137+
<div id="search-wrapper" class="hidden">
138+
<form id="searchbar-outer" class="searchbar-outer">
139+
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
140+
</form>
141+
<div id="searchresults-outer" class="searchresults-outer hidden">
142+
<div id="searchresults-header" class="searchresults-header"></div>
143+
<ul id="searchresults">
144+
</ul>
145+
</div>
146+
</div>
147+
148+
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
149+
<script>
150+
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
151+
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
152+
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
153+
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
154+
});
155+
</script>
156+
157+
<div id="content" class="content">
158+
<main>
159+
<h1 id="document-not-found-404"><a class="header" href="#document-not-found-404">Document not found (404)</a></h1>
160+
<p>This URL is invalid, sorry. Please use the navigation bar or search to continue.</p>
161+
162+
</main>
163+
164+
<nav class="nav-wrapper" aria-label="Page navigation">
165+
<!-- Mobile navigation buttons -->
166+
167+
168+
<div style="clear: both"></div>
169+
</nav>
170+
</div>
171+
</div>
172+
173+
<nav class="nav-wide-wrapper" aria-label="Page navigation">
174+
175+
</nav>
176+
177+
</div>
178+
179+
<!-- Livereload script (if served using the cli tool) -->
180+
<script>
181+
const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
182+
const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
183+
const socket = new WebSocket(wsAddress);
184+
socket.onmessage = function (event) {
185+
if (event.data === "reload") {
186+
socket.close();
187+
location.reload();
188+
}
189+
};
190+
191+
window.onbeforeunload = function() {
192+
socket.close();
193+
}
194+
</script>
195+
196+
197+
198+
<script>
199+
window.playground_copyable = true;
200+
</script>
201+
202+
203+
<script src="elasticlunr.min.js"></script>
204+
<script src="mark.min.js"></script>
205+
<script src="searcher.js"></script>
206+
207+
<script src="clipboard.min.js"></script>
208+
<script src="highlight.js"></script>
209+
<script src="book.js"></script>
210+
211+
<!-- Custom JS scripts -->
212+
<script src="src/static/solidity.min.js"></script>
213+
214+
215+
</div>
216+
</body>
217+
</html>

book/FontAwesome/css/font-awesome.css

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
162 KB
Binary file not shown.
162 KB
Binary file not shown.

0 commit comments

Comments
 (0)