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/Server-requirements.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 doc/md/Server-requirements.md (limited to 'doc/md/Server-requirements.md') diff --git a/doc/md/Server-requirements.md b/doc/md/Server-requirements.md new file mode 100644 index 00000000..b6bbd66a --- /dev/null +++ b/doc/md/Server-requirements.md @@ -0,0 +1,40 @@ +## PHP + +### Release information +- [PHP: Supported versions](http://php.net/supported-versions.php) +- [PHP: Unsupported versions](http://php.net/eol.php) _(EOL - End Of Life)_ +- [PHP 7 Changelog](http://php.net/ChangeLog-7.php) +- [PHP 5 Changelog](http://php.net/ChangeLog-5.php) +- [PHP: Bugs](https://bugs.php.net/) + +### Supported versions +Version | Status | Shaarli compatibility +:---:|:---:|:---: +7.1 | Supported (v0.9.x) | :white_check_mark: +7.0 | Supported | :white_check_mark: +5.6 | Supported | :white_check_mark: +5.5 | EOL: 2016-07-10 | :white_check_mark: +5.4 | EOL: 2015-09-14 | :white_check_mark: (up to Shaarli 0.8.x) +5.3 | EOL: 2014-08-14 | :white_check_mark: (up to Shaarli 0.8.x) + +See also: +- [Travis configuration](https://github.com/shaarli/Shaarli/blob/master/.travis.yml) + +### Dependency management +Starting with Shaarli `v0.8.x`, [Composer](https://getcomposer.org/) is used to resolve, +download and install third-party PHP dependencies. + +Library | Required? | Usage +---|:---:|--- +[`shaarli/netscape-bookmark-parser`](https://packagist.org/packages/shaarli/netscape-bookmark-parser) | All | Import bookmarks from Netscape files +[`erusev/parsedown`](https://packagist.org/packages/erusev/parsedown) | All | Parse MarkDown syntax for the MarkDown plugin +[`slim/slim`](https://packagist.org/packages/slim/slim) | All | Handle routes and middleware for the REST API + +### Extensions +Extension | Required? | Usage +---|:---:|--- +[`openssl`](http://php.net/manual/en/book.openssl.php) | All | OpenSSL, HTTPS +[`php-mbstring`](http://php.net/manual/en/book.mbstring.php) | CentOS, Fedora, RHEL, Windows | multibyte (Unicode) string support +[`php-gd`](http://php.net/manual/en/book.image.php) | optional | thumbnail resizing +[`php-intl`](http://php.net/manual/en/book.intl.php) | optional | localized text sorting (e.g. `e->รจ->f`) +[`php-curl`](http://php.net/manual/en/book.curl.php) | optional | using cURL for fetching webpages and thumbnails in a more robust way -- cgit v1.2.3