]> git.immae.eu Git - github/shaarli/Shaarli.git/commitdiff
Generate HTML documentation using MkDocs (WIP)
authornodiscc <nodiscc@gmail.com>
Thu, 26 Jan 2017 17:52:54 +0000 (18:52 +0100)
committernodiscc <nodiscc@gmail.com>
Sat, 17 Jun 2017 22:19:49 +0000 (00:19 +0200)
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


No differences found