diff options
author | VirtualTam <virtualtam@flibidi.net> | 2017-08-05 11:56:24 +0200 |
---|---|---|
committer | VirtualTam <virtualtam@flibidi.net> | 2017-08-05 11:56:24 +0200 |
commit | 43ad7c8e825057747ccf02049050b323878952a7 (patch) | |
tree | 3160fd640c42f41a38d6c1df2cd4e020f87942ae /doc/md/Download-and-Installation.md | |
parent | b4ff0afb24db6e4cb3543bbd71f01bbb0716b144 (diff) | |
download | Shaarli-43ad7c8e825057747ccf02049050b323878952a7.tar.gz Shaarli-43ad7c8e825057747ccf02049050b323878952a7.tar.zst Shaarli-43ad7c8e825057747ccf02049050b323878952a7.zip |
documentation: fix rendering and internal references
This is mainly cleanup after switching from Github-flavoured Markdown
rendered by Github Pages, to standard Markdown rendered by MkDocs.
Changed:
- rephrase some section titles
Fixed:
- list rendering (items, sub-items))
- code rendering
- quotes
- dead links
Removed:
- extraneous navigational elements
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
Diffstat (limited to 'doc/md/Download-and-Installation.md')
-rw-r--r-- | doc/md/Download-and-Installation.md | 33 |
1 files changed, 16 insertions, 17 deletions
diff --git a/doc/md/Download-and-Installation.md b/doc/md/Download-and-Installation.md index 7880aef4..cdc503a8 100644 --- a/doc/md/Download-and-Installation.md +++ b/doc/md/Download-and-Installation.md | |||
@@ -1,8 +1,16 @@ | |||
1 | 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](Server-requirements) is properly [configured](Server-configuration). | 1 | To install Shaarli, simply place the files in a directory under your webserver's |
2 | Document Root (or directly at the document root). | ||
3 | |||
4 | Also, please make sure your server meets the [requirements](Server-requirements) | ||
5 | and is properly [configured](Server-configuration). | ||
2 | 6 | ||
3 | Several releases are available: | 7 | Several releases are available: |
4 | 8 | ||
5 | -------------------------------------------------------- | 9 | - by downloading full release archives including all dependencies |
10 | - by downloading Github archives | ||
11 | - by cloning the Git repository | ||
12 | |||
13 | --- | ||
6 | 14 | ||
7 | ## Latest release (recommended) | 15 | ## Latest release (recommended) |
8 | ### Download as an archive | 16 | ### Download as an archive |
@@ -20,19 +28,16 @@ $ unzip shaarli-v0.8.4-full.zip | |||
20 | $ mv Shaarli /path/to/shaarli/ | 28 | $ mv Shaarli /path/to/shaarli/ |
21 | ``` | 29 | ``` |
22 | 30 | ||
23 | | ! |In most cases, download Shaarli from the [releases](https://github.com/shaarli/Shaarli/releases) page. Cloning using `git` or downloading Github branches as zip files requires additional steps (see below).| | 31 | In most cases, download Shaarli from the [releases](https://github.com/shaarli/Shaarli/releases) page. Cloning using `git` or downloading Github branches as zip files requires additional steps (see below).| |
24 | |-----|--------------------------| | ||
25 | 32 | ||
26 | ### Using git | 33 | ### Using git |
27 | 34 | ||
28 | ``` | 35 | ``` |
29 | mkdir -p /path/to/shaarli && cd /path/to/shaarli/ | 36 | $ mkdir -p /path/to/shaarli && cd /path/to/shaarli/ |
30 | git clone -b v0.8 https://github.com/shaarli/Shaarli.git . | 37 | $ git clone -b v0.8 https://github.com/shaarli/Shaarli.git . |
31 | composer install --no-dev | 38 | $ composer install --no-dev --prefer-dist |
32 | ``` | 39 | ``` |
33 | 40 | ||
34 | -------------------------------------------------------- | ||
35 | |||
36 | ## Stable version | 41 | ## Stable version |
37 | 42 | ||
38 | The stable version has been experienced by Shaarli users, and will receive security updates. | 43 | The stable version has been experienced by Shaarli users, and will receive security updates. |
@@ -63,11 +68,9 @@ $ mv Shaarli-stable /path/to/shaarli/ | |||
63 | $ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/ | 68 | $ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/ |
64 | # install/update third-party dependencies | 69 | # install/update third-party dependencies |
65 | $ cd /path/to/shaarli/ | 70 | $ cd /path/to/shaarli/ |
66 | $ composer install --no-dev | 71 | $ composer install --no-dev --prefer-dist |
67 | ``` | 72 | ``` |
68 | 73 | ||
69 | -------------------------------------------------------- | ||
70 | |||
71 | ## Development version (mainline) | 74 | ## Development version (mainline) |
72 | 75 | ||
73 | _Use at your own risk!_ | 76 | _Use at your own risk!_ |
@@ -79,11 +82,9 @@ To get the latest changes from the `master` branch: | |||
79 | $ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/ | 82 | $ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/ |
80 | # install/update third-party dependencies | 83 | # install/update third-party dependencies |
81 | $ cd /path/to/shaarli | 84 | $ cd /path/to/shaarli |
82 | $ composer install --no-dev | 85 | $ composer install --no-dev --prefer-dist |
83 | ``` | 86 | ``` |
84 | 87 | ||
85 | -------------------------------------------------------- | ||
86 | |||
87 | ## Finish Installation | 88 | ## Finish Installation |
88 | 89 | ||
89 | Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser. | 90 | Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser. |
@@ -92,8 +93,6 @@ Once Shaarli is downloaded and files have been placed at the correct location, o | |||
92 | 93 | ||
93 | Setup your Shaarli installation, and it's ready to use! | 94 | Setup your Shaarli installation, and it's ready to use! |
94 | 95 | ||
95 | -------------------------------------------------------- | ||
96 | |||
97 | ## Updating Shaarli | 96 | ## Updating Shaarli |
98 | 97 | ||
99 | See [Upgrade and Migration](Upgrade-and-migration) | 98 | See [Upgrade and Migration](Upgrade-and-migration) |