diff options
author | nodiscc <nodiscc@gmail.com> | 2017-01-26 18:52:54 +0100 |
---|---|---|
committer | nodiscc <nodiscc@gmail.com> | 2017-06-18 00:19:49 +0200 |
commit | 53ed6d7d1e678d7486337ce67a2f17b30bac21ac (patch) | |
tree | f8bef0164a70bd03d2b9781951c01bdd018f1842 /doc/md/Directory-structure.md | |
parent | d5d22a6d07917865c44148ad76f43c65a929a890 (diff) | |
download | Shaarli-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/md/Directory-structure.md')
-rw-r--r-- | doc/md/Directory-structure.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/md/Directory-structure.md b/doc/md/Directory-structure.md new file mode 100644 index 00000000..eb50965b --- /dev/null +++ b/doc/md/Directory-structure.md | |||
@@ -0,0 +1,34 @@ | |||
1 | TODO: This page is out of date | ||
2 | |||
3 | Here is the directory structure of Shaarli and the purpose of the different files: | ||
4 | |||
5 | ```bash | ||
6 | index.php # Main program | ||
7 | application/ # Shaarli classes | ||
8 | ├── LinkDB.php | ||
9 | └── Utils.php | ||
10 | tests/ # Shaarli unitary & functional tests | ||
11 | ├── LinkDBTest.php | ||
12 | ├── utils # utilities to ease testing | ||
13 | │ └── ReferenceLinkDB.php | ||
14 | └── UtilsTest.php | ||
15 | COPYING # Shaarli license | ||
16 | inc/ # static assets and 3rd party libraries | ||
17 | ├── awesomplete.* # tags autocompletion 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 | ||
24 | data/ # data storage: bookmark database, configuration, logs, banlist… | ||
25 | ├── config.php # Shaarli configuration (login, password, timezone, title…) | ||
26 | ├── datastore.php # Your link database (compressed). | ||
27 | ├── ipban.php # IP address ban system data | ||
28 | ├── lastupdatecheck.txt # Update check timestamp file | ||
29 | └──log.txt # login/IPban log. | ||
30 | cache/ # thumbnails cache | ||
31 | # This directory is automatically created. You can erase it anytime you want. | ||
32 | tmp/ # Temporary directory for compiled RainTPL templates. | ||
33 | # This directory is automatically created. You can erase it anytime you want. | ||
34 | ``` | ||