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/Download-and-Installation.html | 172 ------------------------------------- 1 file changed, 172 deletions(-) delete mode 100644 doc/Download-and-Installation.html (limited to 'doc/Download-and-Installation.html') diff --git a/doc/Download-and-Installation.html b/doc/Download-and-Installation.html deleted file mode 100644 index 2c5b3be2..00000000 --- a/doc/Download-and-Installation.html +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - - Shaarli – Download and Installation - - - - - - - -

Download and Installation

Get Shaarli!

To install Shaarli, simply place the files in a directory under your webserver's Document Root (or directly at the document root). Make sure your server is properly configured.

Several releases are available:

Latest release (recommended)

Download as an archive

Get the latest released version from the releases page.

Download our shaarli-full archive to include dependencies.

The current latest released version is v0.8.4

Or in command lines:

$ wget https://github.com/shaarli/Shaarli/releases/download/v0.8.4/shaarli-v0.8.4-full.zip
-$ unzip shaarli-v0.8.4-full.zip
-$ mv Shaarli /path/to/shaarli/

- ---- - - - - - - - - -

!	In most cases, download Shaarli from the releases page. Cloning using `git` or downloading Github branches as zip files requires additional steps (see below).

Using git

mkdir -p /path/to/shaarli && cd /path/to/shaarli/
-git clone -b v0.8 https://github.com/shaarli/Shaarli.git .
-composer install --no-dev

Stable version

The stable version has been experienced by Shaarli users, and will receive security updates.

Download as an archive

As a .zip archive:

$ wget https://github.com/shaarli/Shaarli/archive/stable.zip
-$ unzip stable.zip
-$ mv Shaarli-stable /path/to/shaarli/

As a .tar.gz archive :

$ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz
-$ tar xvf stable.tar.gz
-$ mv Shaarli-stable /path/to/shaarli/

Clone with Git

Composer is required to build a functional Shaarli installation when pulling from git.

$ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/
-# install/update third-party dependencies
-$ cd /path/to/shaarli/
-$ composer install --no-dev

Development version (mainline)

Use at your own risk!

To get the latest changes from the master branch:

# clone the repository  
-$ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/
-# install/update third-party dependencies
-$ cd /path/to/shaarli
-$ composer install --no-dev

Finish Installation

Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.

install screenshot

Setup your Shaarli installation, and it's ready to use!

Updating Shaarli

See Upgrade and Migration

- - -- cgit v1.2.3