aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/html/index.html
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2017-01-26 18:52:54 +0100
committernodiscc <nodiscc@gmail.com>2017-06-18 00:19:49 +0200
commit53ed6d7d1e678d7486337ce67a2f17b30bac21ac (patch)
treef8bef0164a70bd03d2b9781951c01bdd018f1842 /doc/html/index.html
parentd5d22a6d07917865c44148ad76f43c65a929a890 (diff)
downloadShaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.gz
Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.zst
Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.zip
Generate HTML documentation using MkDocs (WIP)
MkDocs is a static site generator geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML file. * http://www.mkdocs.org/ * http://www.mkdocs.org/user-guide/configuration/ Ref. #312 * remove pandoc-generated HTML documentation * move markdown doc to doc/md/, * mkdocs.yml: * generate HTML doc in doc/html * add pages TOC/ordering * use index.md as index page * Makefile: remove execute permissions from generated files * Makefile: rewrite htmlpages GFM to markdown conversion using sed: awk expression aslo matched '][' which causes invalid output on complex links with images or code blocks * Add mkdocs.yml to .gitattributes, exclude this file from release archives * Makefile: rename: htmldoc -> doc_html target * run make doc: pull latest markdown documentation from wiki * run make htmlpages: update html documentation
Diffstat (limited to 'doc/html/index.html')
-rw-r--r--doc/html/index.html344
1 files changed, 344 insertions, 0 deletions
diff --git a/doc/html/index.html b/doc/html/index.html
new file mode 100644
index 00000000..a9b0c7b9
--- /dev/null
+++ b/doc/html/index.html
@@ -0,0 +1,344 @@
1<!DOCTYPE html>
2<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
3<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
4<head>
5 <meta charset="utf-8">
6 <meta http-equiv="X-UA-Compatible" content="IE=edge">
7 <meta name="viewport" content="width=device-width, initial-scale=1.0">
8 <meta name="description" content="The personal, minimalist, super-fast, database free, bookmarking service">
9
10 <link rel="shortcut icon" href="./img/favicon.ico">
11 <title>Home - Shaarli Documentation</title>
12 <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
13
14 <link rel="stylesheet" href="./css/theme.css" type="text/css" />
15 <link rel="stylesheet" href="./css/theme_extra.css" type="text/css" />
16 <link rel="stylesheet" href="./css/highlight.css">
17 <link href="./github-markdown.css" rel="stylesheet">
18
19 <script>
20 // Current page data
21 var mkdocs_page_name = "Home";
22 var mkdocs_page_input_path = "index.md";
23 var mkdocs_page_url = "/";
24 </script>
25
26 <script src="./js/jquery-2.1.1.min.js"></script>
27 <script src="./js/modernizr-2.8.3.min.js"></script>
28 <script type="text/javascript" src="./js/highlight.pack.js"></script>
29
30</head>
31
32<body class="wy-body-for-nav" role="document">
33
34 <div class="wy-grid-for-nav">
35
36
37 <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
38 <div class="wy-side-nav-search">
39 <a href="." class="icon icon-home"> Shaarli Documentation</a>
40 <div role="search">
41 <form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
42 <input type="text" name="q" placeholder="Search docs" />
43 </form>
44</div>
45 </div>
46
47 <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
48 <ul class="current">
49
50
51 <li class="toctree-l1 current">
52
53 <a class="current" href=".">Home</a>
54 <ul class="subnav">
55
56 </ul>
57 </li>
58
59 <li class="toctree-l1">
60
61 <span class="caption-text">Setup</span>
62 <ul class="subnav">
63 <li class="">
64
65 <a class="" href="Download-and-Installation/">Download and Installation</a>
66 </li>
67 <li class="">
68
69 <a class="" href="Upgrade-and-migration/">Upgrade and migration</a>
70 </li>
71 <li class="">
72
73 <a class="" href="Server-requirements/">Server requirements</a>
74 </li>
75 <li class="">
76
77 <a class="" href="Server-configuration/">Server configuration</a>
78 </li>
79 <li class="">
80
81 <a class="" href="Server-security/">Server security</a>
82 </li>
83 <li class="">
84
85 <a class="" href="Shaarli-configuration/">Shaarli configuration</a>
86 </li>
87 <li class="">
88
89 <a class="" href="Plugins/">Plugins</a>
90 </li>
91 </ul>
92 </li>
93
94 <li class="toctree-l1">
95
96 <span class="caption-text">Docker</span>
97 <ul class="subnav">
98 <li class="">
99
100 <a class="" href="Docker-101/">Docker 101</a>
101 </li>
102 <li class="">
103
104 <a class="" href="Shaarli-images/">Shaarli images</a>
105 </li>
106 <li class="">
107
108 <a class="" href="Reverse-proxy-configuration/">Reverse proxy configuration</a>
109 </li>
110 <li class="">
111
112 <a class="" href="Docker-resources/">Docker resources</a>
113 </li>
114 </ul>
115 </li>
116
117 <li class="toctree-l1">
118
119 <span class="caption-text">Usage</span>
120 <ul class="subnav">
121 <li class="">
122
123 <a class="" href="Features/">Features</a>
124 </li>
125 <li class="">
126
127 <a class="" href="Bookmarklet/">Bookmarklet</a>
128 </li>
129 <li class="">
130
131 <a class="" href="Browsing-and-searching/">Browsing and searching</a>
132 </li>
133 <li class="">
134
135 <a class="" href="Firefox-share/">Firefox share</a>
136 </li>
137 <li class="">
138
139 <a class="" href="RSS-feeds/">RSS feeds</a>
140 </li>
141 <li class="">
142
143 <a class="" href="REST-API/">REST API</a>
144 </li>
145 </ul>
146 </li>
147
148 <li class="toctree-l1">
149
150 <span class="caption-text">How To</span>
151 <ul class="subnav">
152 <li class="">
153
154 <a class="" href="Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
155 </li>
156 <li class="">
157
158 <a class="" href="Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a>
159 </li>
160 <li class="">
161
162 <a class="" href="Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a>
163 </li>
164 <li class="">
165
166 <a class="" href="Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a>
167 </li>
168 <li class="">
169
170 <a class="" href="Datastore-hacks/">Datastore hacks</a>
171 </li>
172 </ul>
173 </li>
174
175 <li class="toctree-l1">
176
177 <a class="" href="Troubleshooting/">Troubleshooting</a>
178 </li>
179
180 <li class="toctree-l1">
181
182 <span class="caption-text">Development</span>
183 <ul class="subnav">
184 <li class="">
185
186 <a class="" href="Development-guidelines/">Development guidelines</a>
187 </li>
188 <li class="">
189
190 <a class="" href="Continuous-integration-tools/">Continuous integration tools</a>
191 </li>
192 <li class="">
193
194 <a class="" href="GnuPG-signature/">GnuPG signature</a>
195 </li>
196 <li class="">
197
198 <a class="" href="Coding-guidelines/">Coding guidelines</a>
199 </li>
200 <li class="">
201
202 <a class="" href="Directory-structure/">Directory structure</a>
203 </li>
204 <li class="">
205
206 <a class="" href="3rd-party-libraries/">3rd party libraries</a>
207 </li>
208 <li class="">
209
210 <a class="" href="Plugin-System/">Plugin System</a>
211 </li>
212 <li class="">
213
214 <a class="" href="Release-Shaarli/">Release Shaarli</a>
215 </li>
216 <li class="">
217
218 <a class="" href="Versioning-and-Branches/">Versioning and Branches</a>
219 </li>
220 <li class="">
221
222 <a class="" href="Security/">Security</a>
223 </li>
224 <li class="">
225
226 <a class="" href="Static-analysis/">Static analysis</a>
227 </li>
228 <li class="">
229
230 <a class="" href="Theming/">Theming</a>
231 </li>
232 <li class="">
233
234 <a class="" href="Unit-tests/">Unit tests</a>
235 </li>
236 </ul>
237 </li>
238
239 <li class="toctree-l1">
240
241 <span class="caption-text">About</span>
242 <ul class="subnav">
243 <li class="">
244
245 <a class="" href="FAQ/">FAQ</a>
246 </li>
247 <li class="">
248
249 <a class="" href="Community-&-Related-software/">Community & Related software</a>
250 </li>
251 </ul>
252 </li>
253
254 </ul>
255 </div>
256 &nbsp;
257 </nav>
258
259 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
260
261
262 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
263 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
264 <a href=".">Shaarli Documentation</a>
265 </nav>
266
267
268 <div class="wy-nav-content">
269 <div class="rst-content">
270 <div role="navigation" aria-label="breadcrumbs navigation">
271 <ul class="wy-breadcrumbs">
272 <li><a href=".">Docs</a> &raquo;</li>
273
274
275
276 <li>Home</li>
277 <li class="wy-breadcrumbs-aside">
278
279 <a href="https://github.com/shaarli/Shaarli/edit/master/docs/index.md"
280 class="icon icon-github"> Edit on GitHub</a>
281
282 </li>
283 </ul>
284 <hr/>
285</div>
286 <div role="main">
287 <div class="section">
288
289 <p>Welcome to the <a href="https://github.com/shaarli/Shaarli/">Shaarli</a> wiki!</p>
290<p>Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.</p>
291<p>For general info, read the <a href="https://github.com/shaarli/Shaarli/blob/master/README.md">README</a>.</p>
292<p>If you have any questions or ideas, please join the <a href="https://gitter.im/shaarli/Shaarli">chat</a> (also reachable via <a href="https://irc.gitter.im/">IRC</a>), post them in our <a href="https://github.com/shaarli/Shaarli/issues/308">general discussion</a> (<a href="https://github.com/shaarli/Shaarli/issues/44">archive</a>) or read the current <a href="https://github.com/shaarli/Shaarli/issues">issues</a>. If you've found a bug, please create a <a href="https://github.com/shaarli/Shaarli/issues/new">new issue</a>.</p>
293<p>If you would like a feature added to Shaarli, check the issues labeled <a href="https://github.com/shaarli/Shaarli/labels/feature"><code>feature</code></a>, <a href="https://github.com/shaarli/Shaarli/labels/enhancement"><code>enhancement</code></a>, and <a href="https://github.com/shaarli/Shaarli/labels/plugin"><code>plugin</code></a>.</p>
294<p><em>Note: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the <code>doc/</code> directory of your Shaarli installation.</em></p>
295
296 </div>
297 </div>
298 <footer>
299
300 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
301
302 <a href="Download-and-Installation/" class="btn btn-neutral float-right" title="Download and Installation">Next <span class="icon icon-circle-arrow-right"></span></a>
303
304
305 </div>
306
307
308 <hr/>
309
310 <div role="contentinfo">
311 <!-- Copyright etc -->
312
313 </div>
314
315 Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
316</footer>
317
318 </div>
319 </div>
320
321 </section>
322
323 </div>
324
325 <div class="rst-versions" role="note" style="cursor: pointer">
326 <span class="rst-current-version" data-toggle="rst-current-version">
327
328 <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
329
330
331
332 <span style="margin-left: 15px"><a href="Download-and-Installation/" style="color: #fcfcfc">Next &raquo;</a></span>
333
334 </span>
335</div>
336 <script src="./js/theme.js"></script>
337
338</body>
339</html>
340
341<!--
342MkDocs version : 0.16.3
343Build Date UTC : 2017-06-17 22:04:25
344-->
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-07 22:37:46 +0000