-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.xhtml
151 lines (145 loc) · 6.25 KB
/
index.xhtml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>repub</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/epub.css" />
<link rel="stylesheet" type="text/css" href="_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="body" role="main">
<section id="repub">
<h1><code class="docutils literal notranslate"><span class="pre">repub</span></code></h1>
<p>A template for a repository in an always-published state as an:</p>
<ul class="simple">
<li><p>E-Reader compatible <code class="docutils literal notranslate"><span class="pre">.epub</span></code></p></li>
<li><p>installable</p>
<ul>
<li><p>Python Wheel <code class="docutils literal notranslate"><span class="pre">.whl</span></code></p></li>
</ul>
</li>
<li><p>hostable</p>
<ul>
<li><p>JupyterLite application</p></li>
</ul>
</li>
</ul>
<section id="how-it-works">
<h2>How it Works</h2>
<ul class="simple">
<li><p><a class="reference internal" href="#get-started"><span class="std std-doc">get started</span></a></p></li>
<li><p><a class="reference internal" href="#make-changes"><span class="std std-doc">make changes</span></a></p></li>
<li><p><a class="reference internal" href="#publish"><span class="std std-doc">publish</span></a></p></li>
<li><p><a class="reference internal" href="#get-a-link"><span class="std std-doc">get a link</span></a></p></li>
<li><p><a class="reference internal" href="#share"><span class="std std-doc">share</span></a></p></li>
</ul>
</section>
<section id="get-started">
<h2>Get Started</h2>
<section id="localhost">
<h3>Localhost</h3>
<ul class="simple">
<li><p>clone this repo</p>
<ul>
<li><p>or download an archive and unpack it</p></li>
</ul>
</li>
<li><p>host it with your favorite local HTTP server, such as:</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">http.server</span> <span class="pre">-b</span> <span class="pre">127.0.0.1</span></code></p></li>
</ul>
</li>
</ul>
</section>
<section id="other-people-s-computers">
<h3>Other People’s Computers</h3>
<section id="github">
<h4>GitHub</h4>
<ul class="simple">
<li><p>visit https://github.com/deathbeds/repub</p>
<ul>
<li><p>fork the repo into your namespace</p></li>
<li><p>visit <code class="docutils literal notranslate"><span class="pre">https://{your-username}.github.io/{repub}</span></code></p></li>
</ul>
</li>
</ul>
</section>
</section>
</section>
<section id="make-changes">
<h2>Make Changes</h2>
<ul class="simple">
<li><p>from the Web UI</p>
<ul>
<li><p>add files by drag and drop</p></li>
<li><p>edit files directly with the built-in editor</p></li>
<li><p>add new extensions</p></li>
</ul>
</li>
</ul>
</section>
<section id="publish">
<h2>Publish</h2>
</section>
<section id="get-a-link">
<h2>Get a Link</h2>
</section>
<section id="share">
<h2>Share</h2>
<ul class="simple">
<li><p>from your link</p></li>
</ul>
</section>
<section id="documentation-contents">
<h2>Documentation Contents</h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="files.xhtml">Files</a><ul>
<li class="toctree-l2"><a class="reference internal" href="files.xhtml#structure">Structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="files.xhtml#parameters">Parameters</a><ul>
<li class="toctree-l3"><a class="reference internal" href="files.xhtml#name"><code class="docutils literal notranslate"><span class="pre">{:name}</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="files.xhtml#version"><code class="docutils literal notranslate"><span class="pre">{:version}</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="files.xhtml#outputs">Outputs</a><ul>
<li class="toctree-l3"><a class="reference internal" href="files.xhtml#epub"><code class="docutils literal notranslate"><span class="pre">.epub</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="files.xhtml#whl"><code class="docutils literal notranslate"><span class="pre">.whl</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api.xhtml"><code class="docutils literal notranslate"><span class="pre">repub</span></code> API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api.xhtml#module-repub.actions">Actions</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api.xhtml#repub.actions.extract_from_archive"><code class="docutils literal notranslate"><span class="pre">extract_from_archive()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.xhtml">Contributing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="contributing.xhtml#bootstrap-with-mambaforge">Bootstrap with Mambaforge</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.xhtml#create-the-environment">Create the environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.xhtml#use-doit">Use doit</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="changelog.xhtml">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.xhtml#id1"><code class="docutils literal notranslate"><span class="pre">0.1.0</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="roadmap.xhtml">Roadmap</a></li>
</ul>
</div>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
<div class="clearer"></div>
</div>
</body>
</html>