aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md/Directory-structure.md
diff options
context:
space:
mode:
authorArthurHoaro <arthur@hoa.ro>2018-03-28 19:08:06 +0200
committerGitHub <noreply@github.com>2018-03-28 19:08:06 +0200
commitc81f1afc0a3a16daf98741a63c7524b27835da99 (patch)
treedfe81b73f028dfc27eda916b14bf4bc17966b082 /doc/md/Directory-structure.md
parent9b2bd66fb60ffd5a833480bf329062c7d57bc8c4 (diff)
parentd7eb06bd7c4d01bbdf67f4f100af7a3e300098d3 (diff)
downloadShaarli-c81f1afc0a3a16daf98741a63c7524b27835da99.tar.gz
Shaarli-c81f1afc0a3a16daf98741a63c7524b27835da99.tar.zst
Shaarli-c81f1afc0a3a16daf98741a63c7524b27835da99.zip
Merge pull request #1072 from ArthurHoaro/feature/modern-front-end
Manage frontend dependencies with npm/yarn and webpack
Diffstat (limited to 'doc/md/Directory-structure.md')
-rw-r--r--doc/md/Directory-structure.md21
1 files changed, 17 insertions, 4 deletions
diff --git a/doc/md/Directory-structure.md b/doc/md/Directory-structure.md
index 937a076d..c0b49393 100644
--- a/doc/md/Directory-structure.md
+++ b/doc/md/Directory-structure.md
@@ -18,12 +18,18 @@ Here is the directory structure of Shaarli and the purpose of the different file
18 ├── utils # utilities to ease testing 18 ├── utils # utilities to ease testing
19 │ └── ReferenceLinkDB.php 19 │ └── ReferenceLinkDB.php
20 └── 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 └── ...
21 COPYING # Shaarli license 31 COPYING # Shaarli license
22 inc/ # static assets and 3rd party libraries 32 inc/ # static assets and 3rd party libraries
23 ├── awesomplete.* # tags autocompletion library
24 ├── blazy.* # picture wall lazy image loading library
25 ├── shaarli.css, reset.css # Shaarli stylesheet.
26 ├── qr.* # qr code generation library
27 └── rain.tpl.class.php # RainTPL templating library 33 └── rain.tpl.class.php # RainTPL templating library
28 images/ # Images and icons used in Shaarli 34 images/ # Images and icons used in Shaarli
29 data/ # data storage: bookmark database, configuration, logs, banlist... 35 data/ # data storage: bookmark database, configuration, logs, banlist...
@@ -33,6 +39,13 @@ Here is the directory structure of Shaarli and the purpose of the different file
33 ├── lastupdatecheck.txt # Update check timestamp file 39 ├── lastupdatecheck.txt # Update check timestamp file
34 └── log.txt # login/IPban log. 40 └── log.txt # login/IPban log.
35 tpl/ # RainTPL templates for Shaarli. They are used to build the pages. 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 └── ...
36 cache/ # thumbnails cache 49 cache/ # thumbnails cache
37 # 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.
38 tmp/ # Temporary directory for compiled RainTPL templates. 51 tmp/ # Temporary directory for compiled RainTPL templates.