From 53ed6d7d1e678d7486337ce67a2f17b30bac21ac Mon Sep 17 00:00:00 2001
From: nodiscc <nodiscc@gmail.com>
Date: Thu, 26 Jan 2017 18:52:54 +0100
Subject: 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
---
 doc/Directory-structure.md | 33 ---------------------------------
 1 file changed, 33 deletions(-)
 delete mode 100644 doc/Directory-structure.md

(limited to 'doc/Directory-structure.md')

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 @@
-#Directory structure
-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.
-```
-- 
cgit v1.2.3