Development guidelines

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/Development-guidelines/index.html | 352 +++++++++++++++++++++++++++++ 1 file changed, 352 insertions(+) create mode 100644 doc/html/Development-guidelines/index.html (limited to 'doc/html/Development-guidelines/index.html') diff --git a/doc/html/Development-guidelines/index.html b/doc/html/Development-guidelines/index.html new file mode 100644 index 00000000..747d53a8 --- /dev/null +++ b/doc/html/Development-guidelines/index.html @@ -0,0 +1,352 @@ + + + + + + + + + + + Development guidelines - Shaarli Documentation + + + + + + + + + + + + + + + + + +

+ + +

+ Shaarli Documentation + +

+ + + +

+ +

+ + + + + +

+ +

Please have a look at the following pages: +- Contributing to Shaarli +- Static analysis - patches should try to stick to the PHP Standard Recommendations (PSR), especially: + - PSR-1 - Basic Coding Standard + - PSR-2 - Coding Style Guide +- Unit tests +- GnuPG signature for tags/releases

+ +

+ + +

+ +

+ + + GitHub + + + « Previous + + + Next » + + +

+ + + + -- cgit v1.2.3