aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/Directory-structure.md
diff options
context:
space:
mode:
authorVirtualTam <virtualtam@flibidi.net>2015-08-04 16:07:13 +0200
committerVirtualTam <virtualtam@flibidi.net>2015-08-04 16:07:13 +0200
commit27cf2e671d1f35bd8c9383d008cd3733fc1c6e0d (patch)
tree4726baf18e7057eac3f9b6bdb5991fe6117814fc /doc/Directory-structure.md
parent96db105e4c0833324f7168edb5673278de8ccd54 (diff)
parent992af0b9d77cb4fbac2c37ef8d5896042d67a2a3 (diff)
downloadShaarli-27cf2e671d1f35bd8c9383d008cd3733fc1c6e0d.tar.gz
Shaarli-27cf2e671d1f35bd8c9383d008cd3733fc1c6e0d.tar.zst
Shaarli-27cf2e671d1f35bd8c9383d008cd3733fc1c6e0d.zip
Merge pull request #294 from virtualtam/doc/update
Doc: sync from Wiki, generate HTML
Diffstat (limited to 'doc/Directory-structure.md')
-rw-r--r--doc/Directory-structure.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/Directory-structure.md b/doc/Directory-structure.md
new file mode 100644
index 00000000..3a1c4309
--- /dev/null
+++ b/doc/Directory-structure.md
@@ -0,0 +1,33 @@
1#Directory structure
2Here is the directory structure of Shaarli and the purpose of the different files:
3
4```bash
5 index.php # Main program
6 application/ # Shaarli classes
7 ├── LinkDB.php
8 └── Utils.php
9 tests/ # Shaarli unitary & functional tests
10 ├── LinkDBTest.php
11 ├── utils # utilities to ease testing
12 │ └── ReferenceLinkDB.php
13 └── UtilsTest.php
14 COPYING # Shaarli license
15 inc/ # static assets and 3rd party libraries
16 ├── awesomplete.* # tags autocompletion library
17 ├── blazy.* # picture wall lazy image loading library
18 ├── shaarli.css, reset.css # Shaarli stylesheet.
19 ├── qr.* # qr code generation library
20 └──rain.tpl.class.php # RainTPL templating library
21 tpl/ # RainTPL templates for Shaarli. They are used to build the pages.
22 images/ # Images and icons used in Shaarli
23 data/ # data storage: bookmark database, configuration, logs, banlist…
24 ├── config.php # Shaarli configuration (login, password, timezone, title…)
25 ├── datastore.php # Your link database (compressed).
26 ├── ipban.php # IP address ban system data
27 ├── lastupdatecheck.txt # Update check timestamp file
28 └──log.txt # login/IPban log.
29 cache/ # thumbnails cache
30 # This directory is automatically created. You can erase it anytime you want.
31 tmp/ # Temporary directory for compiled RainTPL templates.
32 # This directory is automatically created. You can erase it anytime you want.
33```