Skip to content

Commit 449fe7b

Browse files
zephaniahongzephaniahong
committed
Add generic documentation sections
1 parent 60fe2ac commit 449fe7b

16 files changed

+677
-17
lines changed

‎guide/book/404.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<!-- Custom HTML head -->
1111

1212
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
13-
<meta name="description" content="">
13+
<meta name="description" content="Pip rewritten in Rust">
1414
<meta name="viewport" content="width=device-width, initial-scale=1">
1515
<meta name="theme-color" content="#ffffff" />
1616

@@ -82,7 +82,7 @@
8282

8383
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
8484
<div class="sidebar-scrollbox">
85-
<ol class="chapter"><li class="chapter-item expanded "><a href="chapter_1.html"><strong aria-hidden="true">1.</strong> Chapter 1</a></li></ol>
85+
<ol class="chapter"><li class="chapter-item expanded "><a href="index.html"><strong aria-hidden="true">1.</strong> Introduction</a></li><li class="chapter-item expanded "><a href="installation.html"><strong aria-hidden="true">2.</strong> Installation</a></li><li class="chapter-item expanded "><a href="usage.html"><strong aria-hidden="true">3.</strong> Usage</a></li><li class="chapter-item expanded "><a href="contributing.html"><strong aria-hidden="true">4.</strong> Contributing</a></li><li class="chapter-item expanded "><a href="license.html"><strong aria-hidden="true">5.</strong> License</a></li></ol>
8686
</div>
8787
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
8888
</nav>

‎guide/book/contributing.html

+212
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,212 @@
1+
<!DOCTYPE HTML>
2+
<html lang="en" class="sidebar-visible no-js light">
3+
<head>
4+
<!-- Book generated using mdBook -->
5+
<meta charset="UTF-8">
6+
<title>Contributing - Rust Pip</title>
7+
8+
9+
<!-- Custom HTML head -->
10+
11+
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
12+
<meta name="description" content="Pip rewritten in Rust">
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+
</head>
35+
<body>
36+
<!-- Provide site root to javascript -->
37+
<script type="text/javascript">
38+
var path_to_root = "";
39+
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
40+
</script>
41+
42+
<!-- Work around some values being stored in localStorage wrapped in quotes -->
43+
<script type="text/javascript">
44+
try {
45+
var theme = localStorage.getItem('mdbook-theme');
46+
var sidebar = localStorage.getItem('mdbook-sidebar');
47+
48+
if (theme.startsWith('"') && theme.endsWith('"')) {
49+
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
50+
}
51+
52+
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
53+
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
54+
}
55+
} catch (e) { }
56+
</script>
57+
58+
<!-- Set the theme before any content is loaded, prevents flash -->
59+
<script type="text/javascript">
60+
var theme;
61+
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
62+
if (theme === null || theme === undefined) { theme = default_theme; }
63+
var html = document.querySelector('html');
64+
html.classList.remove('no-js')
65+
html.classList.remove('light')
66+
html.classList.add(theme);
67+
html.classList.add('js');
68+
</script>
69+
70+
<!-- Hide / unhide sidebar before it is displayed -->
71+
<script type="text/javascript">
72+
var html = document.querySelector('html');
73+
var sidebar = 'hidden';
74+
if (document.body.clientWidth >= 1080) {
75+
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
76+
sidebar = sidebar || 'visible';
77+
}
78+
html.classList.remove('sidebar-visible');
79+
html.classList.add("sidebar-" + sidebar);
80+
</script>
81+
82+
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
83+
<div class="sidebar-scrollbox">
84+
<ol class="chapter"><li class="chapter-item expanded "><a href="index.html"><strong aria-hidden="true">1.</strong> Introduction</a></li><li class="chapter-item expanded "><a href="installation.html"><strong aria-hidden="true">2.</strong> Installation</a></li><li class="chapter-item expanded "><a href="usage.html"><strong aria-hidden="true">3.</strong> Usage</a></li><li class="chapter-item expanded "><a href="contributing.html" class="active"><strong aria-hidden="true">4.</strong> Contributing</a></li><li class="chapter-item expanded "><a href="license.html"><strong aria-hidden="true">5.</strong> License</a></li></ol>
85+
</div>
86+
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
87+
</nav>
88+
89+
<div id="page-wrapper" class="page-wrapper">
90+
91+
<div class="page">
92+
<div id="menu-bar-hover-placeholder"></div>
93+
<div id="menu-bar" class="menu-bar sticky bordered">
94+
<div class="left-buttons">
95+
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
96+
<i class="fa fa-bars"></i>
97+
</button>
98+
<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">
99+
<i class="fa fa-paint-brush"></i>
100+
</button>
101+
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
102+
<li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
103+
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
104+
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
105+
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
106+
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
107+
</ul>
108+
<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">
109+
<i class="fa fa-search"></i>
110+
</button>
111+
</div>
112+
113+
<h1 class="menu-title">Rust Pip</h1>
114+
115+
<div class="right-buttons">
116+
<a href="print.html" title="Print this book" aria-label="Print this book">
117+
<i id="print-button" class="fa fa-print"></i>
118+
</a>
119+
120+
</div>
121+
</div>
122+
123+
<div id="search-wrapper" class="hidden">
124+
<form id="searchbar-outer" class="searchbar-outer">
125+
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
126+
</form>
127+
<div id="searchresults-outer" class="searchresults-outer hidden">
128+
<div id="searchresults-header" class="searchresults-header"></div>
129+
<ul id="searchresults">
130+
</ul>
131+
</div>
132+
</div>
133+
134+
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
135+
<script type="text/javascript">
136+
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
137+
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
138+
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
139+
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
140+
});
141+
</script>
142+
143+
<div id="content" class="content">
144+
<main>
145+
<h1 id="contributing"><a class="header" href="#contributing">Contributing</a></h1>
146+
147+
</main>
148+
149+
<nav class="nav-wrapper" aria-label="Page navigation">
150+
<!-- Mobile navigation buttons -->
151+
<a rel="prev" href="usage.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
152+
<i class="fa fa-angle-left"></i>
153+
</a>
154+
155+
<a rel="next" href="license.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
156+
<i class="fa fa-angle-right"></i>
157+
</a>
158+
159+
<div style="clear: both"></div>
160+
</nav>
161+
</div>
162+
</div>
163+
164+
<nav class="nav-wide-wrapper" aria-label="Page navigation">
165+
<a rel="prev" href="usage.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
166+
<i class="fa fa-angle-left"></i>
167+
</a>
168+
169+
<a rel="next" href="license.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
170+
<i class="fa fa-angle-right"></i>
171+
</a>
172+
</nav>
173+
174+
</div>
175+
176+
<!-- Livereload script (if served using the cli tool) -->
177+
<script type="text/javascript">
178+
const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
179+
const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
180+
const socket = new WebSocket(wsAddress);
181+
socket.onmessage = function (event) {
182+
if (event.data === "reload") {
183+
socket.close();
184+
location.reload();
185+
}
186+
};
187+
188+
window.onbeforeunload = function() {
189+
socket.close();
190+
}
191+
</script>
192+
193+
194+
195+
<script type="text/javascript">
196+
window.playground_copyable = true;
197+
</script>
198+
199+
200+
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
201+
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
202+
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
203+
204+
<script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
205+
<script src="highlight.js" type="text/javascript" charset="utf-8"></script>
206+
<script src="book.js" type="text/javascript" charset="utf-8"></script>
207+
208+
<!-- Custom JS scripts -->
209+
210+
211+
</body>
212+
</html>

‎guide/book/index.html

+10-4
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
<head>
44
<!-- Book generated using mdBook -->
55
<meta charset="UTF-8">
6-
<title>Chapter 1 - Rust Pip</title>
6+
<title>Introduction - Rust Pip</title>
77

88

99
<!-- Custom HTML head -->
1010

1111
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
12-
<meta name="description" content="">
12+
<meta name="description" content="Pip rewritten in Rust">
1313
<meta name="viewport" content="width=device-width, initial-scale=1">
1414
<meta name="theme-color" content="#ffffff" />
1515

@@ -81,7 +81,7 @@
8181

8282
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
8383
<div class="sidebar-scrollbox">
84-
<ol class="chapter"><li class="chapter-item expanded "><a href="chapter_1.html" class="active"><strong aria-hidden="true">1.</strong> Chapter 1</a></li></ol>
84+
<ol class="chapter"><li class="chapter-item expanded "><a href="index.html" class="active"><strong aria-hidden="true">1.</strong> Introduction</a></li><li class="chapter-item expanded "><a href="installation.html"><strong aria-hidden="true">2.</strong> Installation</a></li><li class="chapter-item expanded "><a href="usage.html"><strong aria-hidden="true">3.</strong> Usage</a></li><li class="chapter-item expanded "><a href="contributing.html"><strong aria-hidden="true">4.</strong> Contributing</a></li><li class="chapter-item expanded "><a href="license.html"><strong aria-hidden="true">5.</strong> License</a></li></ol>
8585
</div>
8686
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
8787
</nav>
@@ -142,13 +142,16 @@ <h1 class="menu-title">Rust Pip</h1>
142142

143143
<div id="content" class="content">
144144
<main>
145-
<h1 id="chapter-1"><a class="header" href="#chapter-1">Chapter 1</a></h1>
145+
<h1 id="introduction"><a class="header" href="#introduction">Introduction</a></h1>
146146

147147
</main>
148148

149149
<nav class="nav-wrapper" aria-label="Page navigation">
150150
<!-- Mobile navigation buttons -->
151151

152+
<a rel="next" href="installation.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
153+
<i class="fa fa-angle-right"></i>
154+
</a>
152155

153156
<div style="clear: both"></div>
154157
</nav>
@@ -157,6 +160,9 @@ <h1 id="chapter-1"><a class="header" href="#chapter-1">Chapter 1</a></h1>
157160

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

163+
<a rel="next" href="installation.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
164+
<i class="fa fa-angle-right"></i>
165+
</a>
160166
</nav>
161167

162168
</div>

0 commit comments

Comments
 (0)