aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/html/Features
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/Features
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/Features')
-rw-r--r--doc/html/Features/index.html371
1 files changed, 371 insertions, 0 deletions
diff --git a/doc/html/Features/index.html b/doc/html/Features/index.html
new file mode 100644
index 00000000..453f189a
--- /dev/null
+++ b/doc/html/Features/index.html
@@ -0,0 +1,371 @@
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
9
10 <link rel="shortcut icon" href="../img/favicon.ico">
11 <title>Features - 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 = "Features";
22 var mkdocs_page_input_path = "Features.md";
23 var mkdocs_page_url = "/Features/";
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">
52
53 <a class="" href="..">Home</a>
54 </li>
55
56 <li class="toctree-l1">
57
58 <span class="caption-text">Setup</span>
59 <ul class="subnav">
60 <li class="">
61
62 <a class="" href="../Download-and-Installation/">Download and Installation</a>
63 </li>
64 <li class="">
65
66 <a class="" href="../Upgrade-and-migration/">Upgrade and migration</a>
67 </li>
68 <li class="">
69
70 <a class="" href="../Server-requirements/">Server requirements</a>
71 </li>
72 <li class="">
73
74 <a class="" href="../Server-configuration/">Server configuration</a>
75 </li>
76 <li class="">
77
78 <a class="" href="../Server-security/">Server security</a>
79 </li>
80 <li class="">
81
82 <a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
83 </li>
84 <li class="">
85
86 <a class="" href="../Plugins/">Plugins</a>
87 </li>
88 </ul>
89 </li>
90
91 <li class="toctree-l1">
92
93 <span class="caption-text">Docker</span>
94 <ul class="subnav">
95 <li class="">
96
97 <a class="" href="../Docker-101/">Docker 101</a>
98 </li>
99 <li class="">
100
101 <a class="" href="../Shaarli-images/">Shaarli images</a>
102 </li>
103 <li class="">
104
105 <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
106 </li>
107 <li class="">
108
109 <a class="" href="../Docker-resources/">Docker resources</a>
110 </li>
111 </ul>
112 </li>
113
114 <li class="toctree-l1">
115
116 <span class="caption-text">Usage</span>
117 <ul class="subnav">
118 <li class=" current">
119
120 <a class="current" href="./">Features</a>
121 <ul class="subnav">
122
123 <li class="toctree-l3"><a href="#main-features">Main features</a></li>
124
125
126 <li class="toctree-l3"><a href="#using-shaarli-as-a-blog-notepad-pastebin">Using Shaarli as a blog, notepad, pastebin...</a></li>
127
128
129 </ul>
130 </li>
131 <li class="">
132
133 <a class="" href="../Bookmarklet/">Bookmarklet</a>
134 </li>
135 <li class="">
136
137 <a class="" href="../Browsing-and-searching/">Browsing and searching</a>
138 </li>
139 <li class="">
140
141 <a class="" href="../Firefox-share/">Firefox share</a>
142 </li>
143 <li class="">
144
145 <a class="" href="../RSS-feeds/">RSS feeds</a>
146 </li>
147 <li class="">
148
149 <a class="" href="../REST-API/">REST API</a>
150 </li>
151 </ul>
152 </li>
153
154 <li class="toctree-l1">
155
156 <span class="caption-text">How To</span>
157 <ul class="subnav">
158 <li class="">
159
160 <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
161 </li>
162 <li class="">
163
164 <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a>
165 </li>
166 <li class="">
167
168 <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a>
169 </li>
170 <li class="">
171
172 <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a>
173 </li>
174 <li class="">
175
176 <a class="" href="../Datastore-hacks/">Datastore hacks</a>
177 </li>
178 </ul>
179 </li>
180
181 <li class="toctree-l1">
182
183 <a class="" href="../Troubleshooting/">Troubleshooting</a>
184 </li>
185
186 <li class="toctree-l1">
187
188 <span class="caption-text">Development</span>
189 <ul class="subnav">
190 <li class="">
191
192 <a class="" href="../Development-guidelines/">Development guidelines</a>
193 </li>
194 <li class="">
195
196 <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
197 </li>
198 <li class="">
199
200 <a class="" href="../GnuPG-signature/">GnuPG signature</a>
201 </li>
202 <li class="">
203
204 <a class="" href="../Coding-guidelines/">Coding guidelines</a>
205 </li>
206 <li class="">
207
208 <a class="" href="../Directory-structure/">Directory structure</a>
209 </li>
210 <li class="">
211
212 <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
213 </li>
214 <li class="">
215
216 <a class="" href="../Plugin-System/">Plugin System</a>
217 </li>
218 <li class="">
219
220 <a class="" href="../Release-Shaarli/">Release Shaarli</a>
221 </li>
222 <li class="">
223
224 <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
225 </li>
226 <li class="">
227
228 <a class="" href="../Security/">Security</a>
229 </li>
230 <li class="">
231
232 <a class="" href="../Static-analysis/">Static analysis</a>
233 </li>
234 <li class="">
235
236 <a class="" href="../Theming/">Theming</a>
237 </li>
238 <li class="">
239
240 <a class="" href="../Unit-tests/">Unit tests</a>
241 </li>
242 </ul>
243 </li>
244
245 <li class="toctree-l1">
246
247 <span class="caption-text">About</span>
248 <ul class="subnav">
249 <li class="">
250
251 <a class="" href="../FAQ/">FAQ</a>
252 </li>
253 <li class="">
254
255 <a class="" href="../Community-&-Related-software/">Community & Related software</a>
256 </li>
257 </ul>
258 </li>
259
260 </ul>
261 </div>
262 &nbsp;
263 </nav>
264
265 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
266
267
268 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
269 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
270 <a href="..">Shaarli Documentation</a>
271 </nav>
272
273
274 <div class="wy-nav-content">
275 <div class="rst-content">
276 <div role="navigation" aria-label="breadcrumbs navigation">
277 <ul class="wy-breadcrumbs">
278 <li><a href="..">Docs</a> &raquo;</li>
279
280
281
282 <li>Usage &raquo;</li>
283
284
285
286 <li>Features</li>
287 <li class="wy-breadcrumbs-aside">
288
289 <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Features.md"
290 class="icon icon-github"> Edit on GitHub</a>
291
292 </li>
293 </ul>
294 <hr/>
295</div>
296 <div role="main">
297 <div class="section">
298
299 <h3 id="main-features">Main features</h3>
300<p>Shaarli is intended:
301 * to share, comment and save interesting links and news
302 * to bookmark useful/frequent personal links (as private links) and share them between computers
303 * as a minimal blog/microblog/writing platform (no character limit)
304 * as a read-it-later list (for example items tagged <code>readlater</code>)
305 * to draft and save articles/ideas
306 * to keep code snippets
307 * to keep notes and documentation
308 * as a shared clipboard between machines
309 * as a todo list
310 * to store playlists (e.g. with the <code>music</code> or <code>video</code> tags)
311 * to keep extracts/comments from webpages that may disappear
312 * to keep track of ongoing discussions (for example items tagged <code>discussion</code>)
313 * <a href="http://shaarli.chassegnouf.net/?9Efeiw">to feed RSS aggregators</a> (planets) with specific tags
314 * to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...)</p>
315<h3 id="using-shaarli-as-a-blog-notepad-pastebin">Using Shaarli as a blog, notepad, pastebin...</h3>
316<ul>
317<li>Go to your Shaarli setup and log in</li>
318<li>Click the <code>Add Link</code> button</li>
319<li>To share text only, do not enter any URL in the corresponding input field and click <code>Add Link</code></li>
320<li>Pick a title and enter your article, or note, in the description field; add a few tags; optionally check <code>Private</code> then click <code>Save</code></li>
321<li>Voilà! Your article is now published (privately if you selected that option) and accessible using its permalink.</li>
322</ul>
323
324 </div>
325 </div>
326 <footer>
327
328 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
329
330 <a href="../Bookmarklet/" class="btn btn-neutral float-right" title="Bookmarklet">Next <span class="icon icon-circle-arrow-right"></span></a>
331
332
333 <a href="../Docker-resources/" class="btn btn-neutral" title="Docker resources"><span class="icon icon-circle-arrow-left"></span> Previous</a>
334
335 </div>
336
337
338 <hr/>
339
340 <div role="contentinfo">
341 <!-- Copyright etc -->
342
343 </div>
344
345 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>.
346</footer>
347
348 </div>
349 </div>
350
351 </section>
352
353 </div>
354
355 <div class="rst-versions" role="note" style="cursor: pointer">
356 <span class="rst-current-version" data-toggle="rst-current-version">
357
358 <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
359
360
361 <span><a href="../Docker-resources/" style="color: #fcfcfc;">&laquo; Previous</a></span>
362
363
364 <span style="margin-left: 15px"><a href="../Bookmarklet/" style="color: #fcfcfc">Next &raquo;</a></span>
365
366 </span>
367</div>
368 <script src="../js/theme.js"></script>
369
370</body>
371</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-13 08:09:33 +0000