diff options
author | VirtualTam <virtualtam@flibidi.net> | 2015-07-22 05:02:10 +0200 |
---|---|---|
committer | VirtualTam <virtualtam@flibidi.net> | 2015-08-04 16:02:21 +0200 |
commit | 992af0b9d77cb4fbac2c37ef8d5896042d67a2a3 (patch) | |
tree | 4726baf18e7057eac3f9b6bdb5991fe6117814fc /doc/Directory-structure.md | |
parent | 96db105e4c0833324f7168edb5673278de8ccd54 (diff) | |
download | Shaarli-992af0b9d77cb4fbac2c37ef8d5896042d67a2a3.tar.gz Shaarli-992af0b9d77cb4fbac2c37ef8d5896042d67a2a3.tar.zst Shaarli-992af0b9d77cb4fbac2c37ef8d5896042d67a2a3.zip |
Doc: sync from Wiki, generate HTML
Closes #291
Fixes #227
Modifications
- HTML content: match the new Wiki structure
- Makefile
- generate a custom HTML sidebar
- include the sidebar on all pages
- infer and prepend page titles
- handle relative links
- add title metadata, e.g. Shaarli - <Page Name>
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
Diffstat (limited to 'doc/Directory-structure.md')
-rw-r--r-- | doc/Directory-structure.md | 33 |
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 | ||
2 | Here 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 | ``` | ||