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/md/Static-analysis.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 doc/md/Static-analysis.md (limited to 'doc/md/Static-analysis.md') diff --git a/doc/md/Static-analysis.md b/doc/md/Static-analysis.md new file mode 100644 index 00000000..ee4f5978 --- /dev/null +++ b/doc/md/Static-analysis.md @@ -0,0 +1,11 @@ +## WIP +This topic is currently being discussed here: +- [Fix coding style (static analysis)](https://github.com/shaarli/Shaarli/issues/95) (#95) +- [Continuous Integration tools & features](https://github.com/shaarli/Shaarli/issues/130) (#130) + +### Usage +Static analysis tools can be installed with Composer, and used through Shaarli's [Makefile](https://github.com/shaarli/Shaarli/blob/master/Makefile). + +For an overview of the available features, see: +- [Code quality: Makefile to run static code checkers](https://github.com/shaarli/Shaarli/pull/124) (#124) +- [Run PHPCS against different coding standards](https://github.com/shaarli/Shaarli/pull/276) (#276) -- cgit v1.2.3