aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/html/Directory-structure/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/Directory-structure/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/Directory-structure/index.html')
-rw-r--r--doc/html/Directory-structure/index.html371
1 files changed, 371 insertions, 0 deletions
diff --git a/doc/html/Directory-structure/index.html b/doc/html/Directory-structure/index.html
new file mode 100644
index 00000000..82979774
--- /dev/null
+++ b/doc/html/Directory-structure/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>Directory structure - 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 = "Directory structure";
22 var mkdocs_page_input_path = "Directory-structure.md";
23 var mkdocs_page_url = "/Directory-structure/";
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="">
119
120 <a class="" href="../Features/">Features</a>
121 </li>
122 <li class="">
123
124 <a class="" href="../Bookmarklet/">Bookmarklet</a>
125 </li>
126 <li class="">
127
128 <a class="" href="../Browsing-and-searching/">Browsing and searching</a>
129 </li>
130 <li class="">
131
132 <a class="" href="../Firefox-share/">Firefox share</a>
133 </li>
134 <li class="">
135
136 <a class="" href="../RSS-feeds/">RSS feeds</a>
137 </li>
138 <li class="">
139
140 <a class="" href="../REST-API/">REST API</a>
141 </li>
142 </ul>
143 </li>
144
145 <li class="toctree-l1">
146
147 <span class="caption-text">How To</span>
148 <ul class="subnav">
149 <li class="">
150
151 <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
152 </li>
153 <li class="">
154
155 <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a>
156 </li>
157 <li class="">
158
159 <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a>
160 </li>
161 <li class="">
162
163 <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a>
164 </li>
165 <li class="">
166
167 <a class="" href="../Datastore-hacks/">Datastore hacks</a>
168 </li>
169 </ul>
170 </li>
171
172 <li class="toctree-l1">
173
174 <a class="" href="../Troubleshooting/">Troubleshooting</a>
175 </li>
176
177 <li class="toctree-l1">
178
179 <span class="caption-text">Development</span>
180 <ul class="subnav">
181 <li class="">
182
183 <a class="" href="../Development-guidelines/">Development guidelines</a>
184 </li>
185 <li class="">
186
187 <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
188 </li>
189 <li class="">
190
191 <a class="" href="../GnuPG-signature/">GnuPG signature</a>
192 </li>
193 <li class="">
194
195 <a class="" href="../Coding-guidelines/">Coding guidelines</a>
196 </li>
197 <li class=" current">
198
199 <a class="current" href="./">Directory structure</a>
200 <ul class="subnav">
201
202 </ul>
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>Development &raquo;</li>
277
278
279
280 <li>Directory structure</li>
281 <li class="wy-breadcrumbs-aside">
282
283 <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Directory-structure.md"
284 class="icon icon-github"> Edit on GitHub</a>
285
286 </li>
287 </ul>
288 <hr/>
289</div>
290 <div role="main">
291 <div class="section">
292
293 <p>Here is the directory structure of Shaarli and the purpose of the different files:</p>
294<pre><code class="bash"> index.php # Main program
295 application/ # Shaarli classes
296 ├── LinkDB.php
297 └── Utils.php
298 tests/ # Shaarli unitary &amp; functional tests
299 ├── LinkDBTest.php
300 ├── utils # utilities to ease testing
301 │ └── ReferenceLinkDB.php
302 └── UtilsTest.php
303 COPYING # Shaarli license
304 inc/ # static assets and 3rd party libraries
305 ├── awesomplete.* # tags autocompletion library
306 ├── blazy.* # picture wall lazy image loading library
307 ├── shaarli.css, reset.css # Shaarli stylesheet.
308 ├── qr.* # qr code generation library
309 └──rain.tpl.class.php # RainTPL templating library
310 tpl/ # RainTPL templates for Shaarli. They are used to build the pages.
311 images/ # Images and icons used in Shaarli
312 data/ # data storage: bookmark database, configuration, logs, banlist…
313 ├── config.php # Shaarli configuration (login, password, timezone, title…)
314 ├── datastore.php # Your link database (compressed).
315 ├── ipban.php # IP address ban system data
316 ├── lastupdatecheck.txt # Update check timestamp file
317 └──log.txt # login/IPban log.
318 cache/ # thumbnails cache
319 # This directory is automatically created. You can erase it anytime you want.
320 tmp/ # Temporary directory for compiled RainTPL templates.
321 # This directory is automatically created. You can erase it anytime you want.
322</code></pre>
323
324 </div>
325 </div>
326 <footer>
327
328 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
329
330 <a href="../3rd-party-libraries/" class="btn btn-neutral float-right" title="3rd party libraries">Next <span class="icon icon-circle-arrow-right"></span></a>
331
332
333 <a href="../Coding-guidelines/" class="btn btn-neutral" title="Coding guidelines"><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="../Coding-guidelines/" style="color: #fcfcfc;">&laquo; Previous</a></span>
362
363
364 <span style="margin-left: 15px"><a href="../3rd-party-libraries/" 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-11-01 08:40:39 +0000