Coding guidelines - Shaarli Documentation

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

+ + +

+ Shaarli Documentation + +

+ + + +

+ +

+ + + + + +

+ +

WIP

This topic is currently being discussed here: +- Fix coding style (static analysis) (#95) +- Continuous Integration tools & features (#130)

+ +

+ + +

+ +

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

+ + + + -- cgit v1.2.3 From 0433c688b9be6097b85a8fec31b3dacd0ab81677 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sun, 18 Jun 2017 06:32:30 +0200 Subject: make htmlpages --- doc/html/Coding-guidelines/index.html | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) (limited to 'doc/html/Coding-guidelines') diff --git a/doc/html/Coding-guidelines/index.html b/doc/html/Coding-guidelines/index.html index be2bf7e8..dfcdd45c 100644 --- a/doc/html/Coding-guidelines/index.html +++ b/doc/html/Coding-guidelines/index.html @@ -152,19 +152,7 @@

- Copy an existing installation over SSH and serve it locally -

- - Create and serve multiple Shaarlis (farm) -

- - Download CSS styles from an OPML list -

- - Datastore hacks + Various hacks

-- cgit v1.2.3