53ed6d7d1e
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
35 lines
1.8 KiB
Markdown
35 lines
1.8 KiB
Markdown
TODO: This page is out of date
|
|
|
|
Here is the directory structure of Shaarli and the purpose of the different files:
|
|
|
|
```bash
|
|
index.php # Main program
|
|
application/ # Shaarli classes
|
|
├── LinkDB.php
|
|
└── Utils.php
|
|
tests/ # Shaarli unitary & functional tests
|
|
├── LinkDBTest.php
|
|
├── utils # utilities to ease testing
|
|
│ └── ReferenceLinkDB.php
|
|
└── UtilsTest.php
|
|
COPYING # Shaarli license
|
|
inc/ # static assets and 3rd party libraries
|
|
├── awesomplete.* # tags autocompletion library
|
|
├── 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.
|
|
images/ # Images and icons used in Shaarli
|
|
data/ # data storage: bookmark database, configuration, logs, banlist…
|
|
├── config.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.
|
|
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.
|
|
```
|