diff options
Diffstat (limited to 'doc/md/Directory-structure.md')
-rw-r--r-- | doc/md/Directory-structure.md | 44 |
1 files changed, 32 insertions, 12 deletions
diff --git a/doc/md/Directory-structure.md b/doc/md/Directory-structure.md index eb50965b..c0b49393 100644 --- a/doc/md/Directory-structure.md +++ b/doc/md/Directory-structure.md | |||
@@ -1,4 +1,4 @@ | |||
1 | TODO: This page is out of date | 1 | ## Directory structure |
2 | 2 | ||
3 | Here is the directory structure of Shaarli and the purpose of the different files: | 3 | Here is the directory structure of Shaarli and the purpose of the different files: |
4 | 4 | ||
@@ -6,29 +6,49 @@ Here is the directory structure of Shaarli and the purpose of the different file | |||
6 | index.php # Main program | 6 | index.php # Main program |
7 | application/ # Shaarli classes | 7 | application/ # Shaarli classes |
8 | ├── LinkDB.php | 8 | ├── LinkDB.php |
9 | |||
10 | ... | ||
11 | |||
9 | └── Utils.php | 12 | └── Utils.php |
10 | tests/ # Shaarli unitary & functional tests | 13 | tests/ # Shaarli unitary & functional tests |
11 | ├── LinkDBTest.php | 14 | ├── LinkDBTest.php |
12 | ├── utils # utilities to ease testing | 15 | |
16 | ... | ||
17 | |||
18 | ├── utils # utilities to ease testing | ||
13 | │ └── ReferenceLinkDB.php | 19 | │ └── ReferenceLinkDB.php |
14 | └── UtilsTest.php | 20 | └── UtilsTest.php |
21 | assets/ | ||
22 | ├── common/ # Assets shared by multiple themes | ||
23 | ├── ... | ||
24 | ├── default/ # Assets for the default template, before compilation | ||
25 | ├── fonts/ # Font files | ||
26 | ├── img/ # Images used by the default theme | ||
27 | ├── js/ # JavaScript files in ES6 syntax | ||
28 | ├── scss/ # SASS files | ||
29 | └── vintage/ # Assets for the vintage template, before compilation | ||
30 | └── ... | ||
15 | COPYING # Shaarli license | 31 | COPYING # Shaarli license |
16 | inc/ # static assets and 3rd party libraries | 32 | inc/ # static assets and 3rd party libraries |
17 | ├── awesomplete.* # tags autocompletion library | 33 | └── rain.tpl.class.php # RainTPL templating library |
18 | ├── blazy.* # picture wall lazy image loading library | ||
19 | ├── shaarli.css, reset.css # Shaarli stylesheet. | ||
20 | ├── qr.* # qr code generation library | ||
21 | └──rain.tpl.class.php # RainTPL templating library | ||
22 | tpl/ # RainTPL templates for Shaarli. They are used to build the pages. | ||
23 | images/ # Images and icons used in Shaarli | 34 | images/ # Images and icons used in Shaarli |
24 | data/ # data storage: bookmark database, configuration, logs, banlist… | 35 | data/ # data storage: bookmark database, configuration, logs, banlist... |
25 | ├── config.php # Shaarli configuration (login, password, timezone, title…) | 36 | ├── config.json.php # Shaarli configuration (login, password, timezone, title...) |
26 | ├── datastore.php # Your link database (compressed). | 37 | ├── datastore.php # Your link database (compressed). |
27 | ├── ipban.php # IP address ban system data | 38 | ├── ipban.php # IP address ban system data |
28 | ├── lastupdatecheck.txt # Update check timestamp file | 39 | ├── lastupdatecheck.txt # Update check timestamp file |
29 | └──log.txt # login/IPban log. | 40 | └── log.txt # login/IPban log. |
41 | tpl/ # RainTPL templates for Shaarli. They are used to build the pages. | ||
42 | ├── default/ # Default Shaarli theme | ||
43 | ├── fonts/ # Font files | ||
44 | ├── img/ # Images | ||
45 | ├── js/ # JavaScript files compiled by Babel and compatible with all browsers | ||
46 | ├── css/ # CSS files compiled with SASS | ||
47 | └── vintage/ # Legacy Shaarli theme | ||
48 | └── ... | ||
30 | cache/ # thumbnails cache | 49 | cache/ # thumbnails cache |
31 | # This directory is automatically created. You can erase it anytime you want. | 50 | # This directory is automatically created. You can erase it anytime you want. |
32 | tmp/ # Temporary directory for compiled RainTPL templates. | 51 | tmp/ # Temporary directory for compiled RainTPL templates. |
33 | # This directory is automatically created. You can erase it anytime you want. | 52 | # This directory is automatically created. You can erase it anytime you want. |
53 | vendor/ # Third-party dependencies. This directory is created by Composer | ||
34 | ``` | 54 | ``` |