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/html/sitemap.xml | 266 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 266 insertions(+) create mode 100644 doc/html/sitemap.xml (limited to 'doc/html/sitemap.xml') diff --git a/doc/html/sitemap.xml b/doc/html/sitemap.xml new file mode 100644 index 00000000..534f02b5 --- /dev/null +++ b/doc/html/sitemap.xml @@ -0,0 +1,266 @@ + + + + + + / + 2017-06-18 + daily + + + + + + + /Download-and-Installation/ + 2017-06-18 + daily + + + + /Upgrade-and-migration/ + 2017-06-18 + daily + + + + /Server-requirements/ + 2017-06-18 + daily + + + + /Server-configuration/ + 2017-06-18 + daily + + + + /Server-security/ + 2017-06-18 + daily + + + + /Shaarli-configuration/ + 2017-06-18 + daily + + + + /Plugins/ + 2017-06-18 + daily + + + + + + + + /Docker-101/ + 2017-06-18 + daily + + + + /Shaarli-images/ + 2017-06-18 + daily + + + + /Reverse-proxy-configuration/ + 2017-06-18 + daily + + + + /Docker-resources/ + 2017-06-18 + daily + + + + + + + + /Features/ + 2017-06-18 + daily + + + + /Bookmarklet/ + 2017-06-18 + daily + + + + /Browsing-and-searching/ + 2017-06-18 + daily + + + + /Firefox-share/ + 2017-06-18 + daily + + + + /RSS-feeds/ + 2017-06-18 + daily + + + + /REST-API/ + 2017-06-18 + daily + + + + + + + + /Backup,-restore,-import-and-export/ + 2017-06-18 + daily + + + + /Copy-an-existing-installation-over-SSH-and-serve-it-locally/ + 2017-06-18 + daily + + + + /Create-and-serve-multiple-Shaarlis-(farm)/ + 2017-06-18 + daily + + + + /Download-CSS-styles-from-an-OPML-list/ + 2017-06-18 + daily + + + + /Datastore-hacks/ + 2017-06-18 + daily + + + + + + + /Troubleshooting/ + 2017-06-18 + daily + + + + + + + /Development-guidelines/ + 2017-06-18 + daily + + + + /Continuous-integration-tools/ + 2017-06-18 + daily + + + + /GnuPG-signature/ + 2017-06-18 + daily + + + + /Coding-guidelines/ + 2017-06-18 + daily + + + + /Directory-structure/ + 2017-06-18 + daily + + + + /3rd-party-libraries/ + 2017-06-18 + daily + + + + /Plugin-System/ + 2017-06-18 + daily + + + + /Release-Shaarli/ + 2017-06-18 + daily + + + + /Versioning-and-Branches/ + 2017-06-18 + daily + + + + /Security/ + 2017-06-18 + daily + + + + /Static-analysis/ + 2017-06-18 + daily + + + + /Theming/ + 2017-06-18 + daily + + + + /Unit-tests/ + 2017-06-18 + daily + + + + + + + + /FAQ/ + 2017-06-18 + daily + + + + /Community-&-Related-software/ + 2017-06-18 + daily + + + + + \ No newline at end of file -- cgit v1.2.3 From 0433c688b9be6097b85a8fec31b3dacd0ab81677 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sun, 18 Jun 2017 06:32:30 +0200 Subject: make htmlpages --- doc/html/sitemap.xml | 20 +------------------- 1 file changed, 1 insertion(+), 19 deletions(-) (limited to 'doc/html/sitemap.xml') diff --git a/doc/html/sitemap.xml b/doc/html/sitemap.xml index 534f02b5..2a1b009e 100644 --- a/doc/html/sitemap.xml +++ b/doc/html/sitemap.xml @@ -132,25 +132,7 @@ - /Copy-an-existing-installation-over-SSH-and-serve-it-locally/ - 2017-06-18 - daily - - - - /Create-and-serve-multiple-Shaarlis-(farm)/ - 2017-06-18 - daily - - - - /Download-CSS-styles-from-an-OPML-list/ - 2017-06-18 - daily - - - - /Datastore-hacks/ + /Various-hacks/ 2017-06-18 daily -- cgit v1.2.3 From 366247c84cdb0bb0457552468103814d4d31ce5c Mon Sep 17 00:00:00 2001 From: nodiscc Date: Tue, 4 Jul 2017 21:30:31 +0200 Subject: make htmlpages --- doc/html/sitemap.xml | 72 ++++++++++++++++++++++++++-------------------------- 1 file changed, 36 insertions(+), 36 deletions(-) (limited to 'doc/html/sitemap.xml') diff --git a/doc/html/sitemap.xml b/doc/html/sitemap.xml index 2a1b009e..cbf35654 100644 --- a/doc/html/sitemap.xml +++ b/doc/html/sitemap.xml @@ -4,7 +4,7 @@ / - 2017-06-18 + 2017-07-04 daily @@ -13,43 +13,43 @@ /Download-and-Installation/ - 2017-06-18 + 2017-07-04 daily /Upgrade-and-migration/ - 2017-06-18 + 2017-07-04 daily /Server-requirements/ - 2017-06-18 + 2017-07-04 daily /Server-configuration/ - 2017-06-18 + 2017-07-04 daily /Server-security/ - 2017-06-18 + 2017-07-04 daily /Shaarli-configuration/ - 2017-06-18 + 2017-07-04 daily /Plugins/ - 2017-06-18 + 2017-07-04 daily @@ -59,25 +59,25 @@ /Docker-101/ - 2017-06-18 + 2017-07-04 daily /Shaarli-images/ - 2017-06-18 + 2017-07-04 daily /Reverse-proxy-configuration/ - 2017-06-18 + 2017-07-04 daily /Docker-resources/ - 2017-06-18 + 2017-07-04 daily @@ -87,37 +87,37 @@ /Features/ - 2017-06-18 + 2017-07-04 daily /Bookmarklet/ - 2017-06-18 + 2017-07-04 daily /Browsing-and-searching/ - 2017-06-18 + 2017-07-04 daily /Firefox-share/ - 2017-06-18 + 2017-07-04 daily /RSS-feeds/ - 2017-06-18 + 2017-07-04 daily /REST-API/ - 2017-06-18 + 2017-07-04 daily @@ -127,13 +127,13 @@ /Backup,-restore,-import-and-export/ - 2017-06-18 + 2017-07-04 daily /Various-hacks/ - 2017-06-18 + 2017-07-04 daily @@ -142,7 +142,7 @@ /Troubleshooting/ - 2017-06-18 + 2017-07-04 daily @@ -151,79 +151,79 @@ /Development-guidelines/ - 2017-06-18 + 2017-07-04 daily /Continuous-integration-tools/ - 2017-06-18 + 2017-07-04 daily /GnuPG-signature/ - 2017-06-18 + 2017-07-04 daily /Coding-guidelines/ - 2017-06-18 + 2017-07-04 daily /Directory-structure/ - 2017-06-18 + 2017-07-04 daily /3rd-party-libraries/ - 2017-06-18 + 2017-07-04 daily /Plugin-System/ - 2017-06-18 + 2017-07-04 daily /Release-Shaarli/ - 2017-06-18 + 2017-07-04 daily /Versioning-and-Branches/ - 2017-06-18 + 2017-07-04 daily /Security/ - 2017-06-18 + 2017-07-04 daily /Static-analysis/ - 2017-06-18 + 2017-07-04 daily /Theming/ - 2017-06-18 + 2017-07-04 daily /Unit-tests/ - 2017-06-18 + 2017-07-04 daily @@ -233,13 +233,13 @@ /FAQ/ - 2017-06-18 + 2017-07-04 daily /Community-&-Related-software/ - 2017-06-18 + 2017-07-04 daily -- cgit v1.2.3