X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fmd%2FDirectory-structure.md;h=937a076d0c6646c8e53069748af033b1ef5d0723;hb=2e6b9ed3b9d5c813b0136230f6ac659df9ed46e7;hp=eb50965b124c4e15172b1d8cea8e9ae4a64663b4;hpb=5b25a9635fe808bc1c4f3eee8cdf8485115da75d;p=github%2Fshaarli%2FShaarli.git diff --git a/doc/md/Directory-structure.md b/doc/md/Directory-structure.md index eb50965b..937a076d 100644 --- a/doc/md/Directory-structure.md +++ b/doc/md/Directory-structure.md @@ -1,4 +1,4 @@ -TODO: This page is out of date +## Directory structure Here is the directory structure of Shaarli and the purpose of the different files: @@ -6,10 +6,16 @@ Here is the directory structure of Shaarli and the purpose of the different file index.php # Main program application/ # Shaarli classes ├── LinkDB.php + + ... + └── Utils.php - tests/ # Shaarli unitary & functional tests + tests/ # Shaarli unitary & functional tests ├── LinkDBTest.php - ├── utils # utilities to ease testing + + ... + + ├── utils # utilities to ease testing │ └── ReferenceLinkDB.php └── UtilsTest.php COPYING # Shaarli license @@ -18,17 +24,18 @@ Here is the directory structure of Shaarli and the purpose of the different file ├── blazy.* # picture wall lazy image loading library ├── shaarli.css, reset.css # Shaarli stylesheet. ├── qr.* # qr code generation library - └──rain.tpl.class.php # RainTPL templating library - tpl/ # RainTPL templates for Shaarli. They are used to build the pages. + └── rain.tpl.class.php # RainTPL templating library images/ # Images and icons used in Shaarli - data/ # data storage: bookmark database, configuration, logs, banlist… - ├── config.php # Shaarli configuration (login, password, timezone, title…) + data/ # data storage: bookmark database, configuration, logs, banlist... + ├── config.json.php # Shaarli configuration (login, password, timezone, title...) ├── datastore.php # Your link database (compressed). ├── ipban.php # IP address ban system data ├── lastupdatecheck.txt # Update check timestamp file - └──log.txt # login/IPban log. + └── log.txt # login/IPban log. + tpl/ # RainTPL templates for Shaarli. They are used to build the pages. cache/ # thumbnails cache # This directory is automatically created. You can erase it anytime you want. tmp/ # Temporary directory for compiled RainTPL templates. # This directory is automatically created. You can erase it anytime you want. + vendor/ # Third-party dependencies. This directory is created by Composer ```