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/Development.html | 112 --------------------------------------------------- 1 file changed, 112 deletions(-) delete mode 100644 doc/Development.html (limited to 'doc/Development.html') diff --git a/doc/Development.html b/doc/Development.html deleted file mode 100644 index 8a2be413..00000000 --- a/doc/Development.html +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - Shaarli – Development - - - - - -
- -
-

Development

-

Guidelines

-

Please have a look at the following pages:

- -

Continuous integration tools

-

Local development

-

A Makefile is available to perform project-related operations:

- -

Automatic builds

-

Travis CI is a Continuous Integration build server, that runs a build:

- -

A build is composed of several jobs: one for each supported PHP version (see Server requirements).

-

Each build job:

- -

After all jobs have finished, Travis returns the results to GitHub:

- - - -- cgit v1.2.3