Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
MyShaarli/doc/md/Server-requirements.md
nodiscc 53ed6d7d1e 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
2017-06-18 00:19:49 +02:00

1.9 KiB
Raw Blame History

PHP

Release information

Supported versions

Version Status Shaarli compatibility
7.1 Supported (v0.9.x) ✅
7.0 Supported ✅
5.6 Supported ✅
5.5 EOL: 2016-07-10 ✅
5.4 EOL: 2015-09-14 ✅ (up to Shaarli 0.8.x)
5.3 EOL: 2014-08-14 ✅ (up to Shaarli 0.8.x)

See also:

Dependency management

Starting with Shaarli v0.8.x, Composer is used to resolve, download and install third-party PHP dependencies.

Library Required? Usage
shaarli/netscape-bookmark-parser All Import bookmarks from Netscape files
erusev/parsedown All Parse MarkDown syntax for the MarkDown plugin
slim/slim All Handle routes and middleware for the REST API

Extensions

Extension Required? Usage
openssl All OpenSSL, HTTPS
php-mbstring CentOS, Fedora, RHEL, Windows multibyte (Unicode) string support
php-gd optional thumbnail resizing
php-intl optional localized text sorting (e.g. e->è->f)
php-curl optional using cURL for fetching webpages and thumbnails in a more robust way