From 53ed6d7d1e678d7486337ce67a2f17b30bac21ac Mon Sep 17 00:00:00 2001 From: nodiscc 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/md/images/bookmarklet.png | Bin 0 -> 53346 bytes doc/md/images/doc-logo.png | Bin 0 -> 19543 bytes doc/md/images/doc-logo.svg | 522 +++++++++++++++++++++++++++++++++++++++++ doc/md/images/firefoxshare.png | Bin 0 -> 757 bytes doc/md/images/rss-filter-1.png | Bin 0 -> 18682 bytes doc/md/images/rss-filter-2.png | Bin 0 -> 15604 bytes 6 files changed, 522 insertions(+) create mode 100644 doc/md/images/bookmarklet.png create mode 100644 doc/md/images/doc-logo.png create mode 100644 doc/md/images/doc-logo.svg create mode 100644 doc/md/images/firefoxshare.png create mode 100644 doc/md/images/rss-filter-1.png create mode 100644 doc/md/images/rss-filter-2.png (limited to 'doc/md/images') diff --git a/doc/md/images/bookmarklet.png b/doc/md/images/bookmarklet.png new file mode 100644 index 00000000..0262578e Binary files /dev/null and b/doc/md/images/bookmarklet.png differ diff --git a/doc/md/images/doc-logo.png b/doc/md/images/doc-logo.png new file mode 100644 index 00000000..3d8d1787 Binary files /dev/null and b/doc/md/images/doc-logo.png differ diff --git a/doc/md/images/doc-logo.svg b/doc/md/images/doc-logo.svg new file mode 100644 index 00000000..37fc6658 --- /dev/null +++ b/doc/md/images/doc-logo.svg @@ -0,0 +1,522 @@ + + + Shaarli Logo + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + Shaarli Logo + + + http://blog.idleman.fr/ + + + 2012-08-29 22:36:01+02:00 + + + http://sebsauvage.net/ + + + + + Shaarli + Logo + + + + + http://thatguynamedandy.com/, +http://mro.name/me + + + + http://sebsauvage.net/files/shaarli_logo.zip + http://sebsauvage.net/wiki/doku.php?id=php:shaarli:discussion#comment_09a1e91bc0abc7db6d186a6abf429877 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/md/images/firefoxshare.png b/doc/md/images/firefoxshare.png new file mode 100644 index 00000000..98c2fdd3 Binary files /dev/null and b/doc/md/images/firefoxshare.png differ diff --git a/doc/md/images/rss-filter-1.png b/doc/md/images/rss-filter-1.png new file mode 100644 index 00000000..d2a03f67 Binary files /dev/null and b/doc/md/images/rss-filter-1.png differ diff --git a/doc/md/images/rss-filter-2.png b/doc/md/images/rss-filter-2.png new file mode 100644 index 00000000..538b126e Binary files /dev/null and b/doc/md/images/rss-filter-2.png differ -- cgit v1.2.3