aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/Directory-structure.md
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2017-01-26 18:52:54 +0100
committernodiscc <nodiscc@gmail.com>2017-06-18 00:19:49 +0200
commit53ed6d7d1e678d7486337ce67a2f17b30bac21ac (patch)
treef8bef0164a70bd03d2b9781951c01bdd018f1842 /doc/Directory-structure.md
parentd5d22a6d07917865c44148ad76f43c65a929a890 (diff)
downloadShaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.gz
Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.zst
Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.zip
Generate HTML documentation using MkDocs (WIP)
MkDocs is a static site generator geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML file. * http://www.mkdocs.org/ * http://www.mkdocs.org/user-guide/configuration/ Ref. #312 * remove pandoc-generated HTML documentation * move markdown doc to doc/md/, * mkdocs.yml: * generate HTML doc in doc/html * add pages TOC/ordering * use index.md as index page * Makefile: remove execute permissions from generated files * Makefile: rewrite htmlpages GFM to markdown conversion using sed: awk expression aslo matched '][' which causes invalid output on complex links with images or code blocks * Add mkdocs.yml to .gitattributes, exclude this file from release archives * Makefile: rename: htmldoc -> doc_html target * run make doc: pull latest markdown documentation from wiki * run make htmlpages: update html documentation
Diffstat (limited to 'doc/Directory-structure.md')
-rw-r--r--doc/Directory-structure.md33
1 files changed, 0 insertions, 33 deletions
diff --git a/doc/Directory-structure.md b/doc/Directory-structure.md
deleted file mode 100644
index 3a1c4309..00000000
--- a/doc/Directory-structure.md
+++ /dev/null
@@ -1,33 +0,0 @@
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```