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 --- .gitattributes | 1 + 1 file changed, 1 insertion(+) (limited to '.gitattributes') diff --git a/.gitattributes b/.gitattributes index 82f37602..dd0e573c 100644 --- a/.gitattributes +++ b/.gitattributes @@ -33,5 +33,6 @@ doc/**/*.md export-ignore docker/ export-ignore Doxyfile export-ignore Makefile export-ignore +mkdocs.yml export-ignore phpunit.xml export-ignore tests/ export-ignore -- cgit v1.2.3