aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/Server-requirements.md
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2017-01-26 18:52:54 +0100
committernodiscc <nodiscc@gmail.com>2017-06-18 00:19:49 +0200
commit53ed6d7d1e678d7486337ce67a2f17b30bac21ac (patch)
treef8bef0164a70bd03d2b9781951c01bdd018f1842 /doc/Server-requirements.md
parentd5d22a6d07917865c44148ad76f43c65a929a890 (diff)
downloadShaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.gz
Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.zst
Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.zip
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
Diffstat (limited to 'doc/Server-requirements.md')
-rw-r--r--doc/Server-requirements.md40
1 files changed, 0 insertions, 40 deletions
diff --git a/doc/Server-requirements.md b/doc/Server-requirements.md
deleted file mode 100644
index 07e70ab3..00000000
--- a/doc/Server-requirements.md
+++ /dev/null
@@ -1,40 +0,0 @@
1#Server requirements
2## PHP
3### Release information
4- [PHP: Supported versions](http://php.net/supported-versions.php)[](.html)
5- [PHP: Unsupported versions](http://php.net/eol.php) _(EOL - End Of Life)_[](.html)
6- [PHP 7 Changelog](http://php.net/ChangeLog-7.php)[](.html)
7- [PHP 5 Changelog](http://php.net/ChangeLog-5.php)[](.html)
8- [PHP: Bugs](https://bugs.php.net/)[](.html)
9
10### Supported versions
11Version | Status | Shaarli compatibility
12:---:|:---:|:---:
137.1 | Supported (v0.9.x) | :white_check_mark:
147.0 | Supported | :white_check_mark:
155.6 | Supported | :white_check_mark:
165.5 | EOL: 2016-07-10 | :white_check_mark:
175.4 | EOL: 2015-09-14 | :white_check_mark: (up to Shaarli 0.8.x)
185.3 | EOL: 2014-08-14 | :white_check_mark: (up to Shaarli 0.8.x)
19
20See also:
21- [Travis configuration](https://github.com/shaarli/Shaarli/blob/master/.travis.yml)[](.html)
22
23### Dependency management
24Starting with Shaarli `v0.8.x`, [Composer](https://getcomposer.org/) is used to resolve,[](.html)
25download and install third-party PHP dependencies.
26
27Library | Required? | Usage
28---|:---:|---
29[`shaarli/netscape-bookmark-parser`](https://packagist.org/packages/shaarli/netscape-bookmark-parser) | All | Import bookmarks from Netscape files[](.html)
30[`erusev/parsedown`](https://packagist.org/packages/erusev/parsedown) | All | Parse MarkDown syntax for the MarkDown plugin[](.html)
31[`slim/slim`](https://packagist.org/packages/slim/slim) | All | Handle routes and middleware for the REST API[](.html)
32
33### Extensions
34Extension | Required? | Usage
35---|:---:|---
36[`openssl`](http://php.net/manual/en/book.openssl.php) | All | OpenSSL, HTTPS[](.html)
37[`php-mbstring`](http://php.net/manual/en/book.mbstring.php) | CentOS, Fedora, RHEL, Windows | multibyte (Unicode) string support[](.html)
38[`php-gd`](http://php.net/manual/en/book.image.php) | optional | thumbnail resizing[](.html)
39[`php-intl`](http://php.net/manual/en/book.intl.php) | optional | localized text sorting (e.g. `e->รจ->f`)[](.html)
40[`php-curl`](http://php.net/manual/en/book.curl.php) | optional | using cURL for fetching webpages and thumbnails in a more robust way[](.html)