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/Development-guidelines.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 doc/md/Development-guidelines.md (limited to 'doc/md/Development-guidelines.md') diff --git a/doc/md/Development-guidelines.md b/doc/md/Development-guidelines.md new file mode 100644 index 00000000..1480ec89 --- /dev/null +++ b/doc/md/Development-guidelines.md @@ -0,0 +1,9 @@ +## Development guidelines + +Please have a look at the following pages: +- [Contributing to Shaarli](https://github.com/shaarli/Shaarli/tree/master/CONTRIBUTING.md) +- [[Static analysis]] - patches should try to stick to the [PHP Standard Recommendations](http://www.php-fig.org/psr/) (PSR), especially: + - [PSR-1](http://www.php-fig.org/psr/psr-1/) - Basic Coding Standard + - [PSR-2](http://www.php-fig.org/psr/psr-2/) - Coding Style Guide +- [[Unit tests]] +- [[GnuPG signature]] for tags/releases -- cgit v1.2.3