aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2017-06-18 06:32:30 +0200
committernodiscc <nodiscc@gmail.com>2017-06-18 06:32:30 +0200
commit0433c688b9be6097b85a8fec31b3dacd0ab81677 (patch)
tree74f18e5c6c993ec0c920a96c3321f82831388de8 /doc/md
parent460ce50115e5f5a1183c3c410fd76636ee5c4716 (diff)
downloadShaarli-0433c688b9be6097b85a8fec31b3dacd0ab81677.tar.gz
Shaarli-0433c688b9be6097b85a8fec31b3dacd0ab81677.tar.zst
Shaarli-0433c688b9be6097b85a8fec31b3dacd0ab81677.zip
make htmlpages
Diffstat (limited to 'doc/md')
-rw-r--r--doc/md/Browsing-and-searching.md2
-rw-r--r--doc/md/Community-&-Related-software.md2
-rw-r--r--doc/md/Continuous-integration-tools.md8
-rw-r--r--doc/md/Development-guidelines.md6
-rw-r--r--doc/md/Firefox-share.md2
-rw-r--r--doc/md/GnuPG-signature.md2
-rw-r--r--doc/md/Theming.md4
-rw-r--r--doc/md/Upgrade-and-migration.md10
8 files changed, 18 insertions, 18 deletions
diff --git a/doc/md/Browsing-and-searching.md b/doc/md/Browsing-and-searching.md
index ad62c2f0..35707482 100644
--- a/doc/md/Browsing-and-searching.md
+++ b/doc/md/Browsing-and-searching.md
@@ -20,4 +20,4 @@ To search for links that are not tagged, enter `""` in the tag search field.
20 20
21## Filtering RSS feeds/Picture wall 21## Filtering RSS feeds/Picture wall
22 22
23RSS feeds can also be restricted to only return items matching a text/tag search: see [[RSS feeds]]. 23RSS feeds can also be restricted to only return items matching a text/tag search: see [RSS feeds](RSS feeds).
diff --git a/doc/md/Community-&-Related-software.md b/doc/md/Community-&-Related-software.md
index 6ff7ed45..b8b7cccd 100644
--- a/doc/md/Community-&-Related-software.md
+++ b/doc/md/Community-&-Related-software.md
@@ -34,7 +34,7 @@ _TODO: contact repos owners to see if they'd like to standardize their work with
34 34
35 35
36### Themes 36### Themes
37See [[Theming]] for the list of community-contributed themes, and an installation guide. 37See [Theming](Theming) for the list of community-contributed themes, and an installation guide.
38 38
39### Server apps 39### Server apps
40- [shaarchiver](https://github.com/nodiscc/shaarchiver) - Archive your Shaarli bookmarks and their content 40- [shaarchiver](https://github.com/nodiscc/shaarchiver) - Archive your Shaarli bookmarks and their content
diff --git a/doc/md/Continuous-integration-tools.md b/doc/md/Continuous-integration-tools.md
index 30dc474d..849257f7 100644
--- a/doc/md/Continuous-integration-tools.md
+++ b/doc/md/Continuous-integration-tools.md
@@ -1,20 +1,20 @@
1## Local development 1## Local development
2A [`Makefile`](https://github.com/shaarli/Shaarli/blob/master/Makefile) is available to perform project-related operations: 2A [`Makefile`](https://github.com/shaarli/Shaarli/blob/master/Makefile) is available to perform project-related operations:
3- Documentation - generate a local HTML copy of the GitHub wiki 3- Documentation - generate a local HTML copy of the GitHub wiki
4- [[Static analysis]] - check that the code is compliant to PHP conventions 4- [Static analysis](Static analysis) - check that the code is compliant to PHP conventions
5- [[Unit tests]] - ensure there are no regressions introduced by new commits 5- [Unit tests](Unit tests) - ensure there are no regressions introduced by new commits
6 6
7## Automatic builds 7## Automatic builds
8[Travis CI](http://docs.travis-ci.com/) is a Continuous Integration build server, that runs a build: 8[Travis CI](http://docs.travis-ci.com/) is a Continuous Integration build server, that runs a build:
9- each time a commit is merged to the mainline (`master` branch) 9- each time a commit is merged to the mainline (`master` branch)
10- each time a Pull Request is submitted or updated 10- each time a Pull Request is submitted or updated
11 11
12A build is composed of several jobs: one for each supported PHP version (see [[Server requirements]]). 12A build is composed of several jobs: one for each supported PHP version (see [Server requirements](Server requirements)).
13 13
14Each build job: 14Each build job:
15- updates Composer 15- updates Composer
16- installs 3rd-party test dependencies with Composer 16- installs 3rd-party test dependencies with Composer
17- runs [[Unit tests]] 17- runs [Unit tests](Unit tests)
18 18
19After all jobs have finished, Travis returns the results to GitHub: 19After all jobs have finished, Travis returns the results to GitHub:
20- a status icon represents the result for the `master` branch: [![](https://api.travis-ci.org/shaarli/Shaarli.svg)](https://travis-ci.org/shaarli/Shaarli) 20- a status icon represents the result for the `master` branch: [![](https://api.travis-ci.org/shaarli/Shaarli.svg)](https://travis-ci.org/shaarli/Shaarli)
diff --git a/doc/md/Development-guidelines.md b/doc/md/Development-guidelines.md
index 1480ec89..3a248767 100644
--- a/doc/md/Development-guidelines.md
+++ b/doc/md/Development-guidelines.md
@@ -2,8 +2,8 @@
2 2
3Please have a look at the following pages: 3Please have a look at the following pages:
4- [Contributing to Shaarli](https://github.com/shaarli/Shaarli/tree/master/CONTRIBUTING.md) 4- [Contributing to Shaarli](https://github.com/shaarli/Shaarli/tree/master/CONTRIBUTING.md)
5- [[Static analysis]] - patches should try to stick to the [PHP Standard Recommendations](http://www.php-fig.org/psr/) (PSR), especially: 5- [Static analysis](Static analysis) - patches should try to stick to the [PHP Standard Recommendations](http://www.php-fig.org/psr/) (PSR), especially:
6 - [PSR-1](http://www.php-fig.org/psr/psr-1/) - Basic Coding Standard 6 - [PSR-1](http://www.php-fig.org/psr/psr-1/) - Basic Coding Standard
7 - [PSR-2](http://www.php-fig.org/psr/psr-2/) - Coding Style Guide 7 - [PSR-2](http://www.php-fig.org/psr/psr-2/) - Coding Style Guide
8- [[Unit tests]] 8- [Unit tests](Unit tests)
9- [[GnuPG signature]] for tags/releases 9- [GnuPG signature](GnuPG signature) for tags/releases
diff --git a/doc/md/Firefox-share.md b/doc/md/Firefox-share.md
index 9ba57b04..595b9400 100644
--- a/doc/md/Firefox-share.md
+++ b/doc/md/Firefox-share.md
@@ -8,7 +8,7 @@
8### Sharing links using Firefox share 8### Sharing links using Firefox share
9 9
10 * Add the sharing service as described above 10 * Add the sharing service as described above
11 * When you are visiting a webpage you would like to share with Shaarli, click the Firefox _Share_ button [[images/firefoxshare.png]] 11 * When you are visiting a webpage you would like to share with Shaarli, click the Firefox _Share_ button [images/firefoxshare.png](images/firefoxshare.png)
12 * You can edit your link before and after saving, just like the bookmarklet above. 12 * You can edit your link before and after saving, just like the bookmarklet above.
13 13
14|  | Your Shaarli instance must be hosted on an HTTPS (SSL/TLS secure connection) enabled server for Firefox Share to work. Firefox Share will not work over plain HTTP connections. | 14|  | Your Shaarli instance must be hosted on an HTTPS (SSL/TLS secure connection) enabled server for Firefox Share to work. Firefox Share will not work over plain HTTP connections. |
diff --git a/doc/md/GnuPG-signature.md b/doc/md/GnuPG-signature.md
index 1fb3b42f..62a17d33 100644
--- a/doc/md/GnuPG-signature.md
+++ b/doc/md/GnuPG-signature.md
@@ -73,4 +73,4 @@ gpg: sending key A9D53A3E to hkp server pgp.mit.edu
73 73
74## Create and push a GPG-signed tag 74## Create and push a GPG-signed tag
75 75
76See [[Release Shaarli]]. 76See [Release Shaarli](Release Shaarli).
diff --git a/doc/md/Theming.md b/doc/md/Theming.md
index ae68db38..d72c2ffd 100644
--- a/doc/md/Theming.md
+++ b/doc/md/Theming.md
@@ -15,7 +15,7 @@ This file allows overriding rules defined in the template CSS files (only add ch
15 15
16**Note**: Do not edit `tpl/default/css/shaarli.css`! Your changes would be overridden when updating Shaarli. 16**Note**: Do not edit `tpl/default/css/shaarli.css`! Your changes would be overridden when updating Shaarli.
17 17
18See also [[Download CSS styles from an OPML list]] 18See also [Download CSS styles from an OPML list](Download CSS styles from an OPML list)
19 19
20## Themes 20## Themes
21 21
@@ -77,7 +77,7 @@ Get config written:
77- fill the install form 77- fill the install form
78- log in to Shaarli 78- log in to Shaarli
79 79
80Edit Shaarli's [[configuration|Shaarli configuration]]: 80Edit Shaarli's [configuration|Shaarli configuration](configuration|Shaarli configuration):
81```bash 81```bash
82# the file should be owned by Apache, thus not writeable => sudo 82# the file should be owned by Apache, thus not writeable => sudo
83$ sudo sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php 83$ sudo sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php
diff --git a/doc/md/Upgrade-and-migration.md b/doc/md/Upgrade-and-migration.md
index 7348891f..2002a4e2 100644
--- a/doc/md/Upgrade-and-migration.md
+++ b/doc/md/Upgrade-and-migration.md
@@ -13,7 +13,7 @@ Shaarli stores all user data under the `data` directory:
13- `data/ipbans.php` - banned IP addresses 13- `data/ipbans.php` - banned IP addresses
14- `data/updates.txt` - contains all automatic update to the configuration and datastore files already run 14- `data/updates.txt` - contains all automatic update to the configuration and datastore files already run
15 15
16See [[Shaarli configuration]] for more information about Shaarli resources. 16See [Shaarli configuration](Shaarli configuration) for more information about Shaarli resources.
17 17
18It is recommended to backup this repository _before_ starting updating/upgrading Shaarli: 18It is recommended to backup this repository _before_ starting updating/upgrading Shaarli:
19- users with SSH access: copy or archive the directory to a temporary location 19- users with SSH access: copy or archive the directory to a temporary location
@@ -25,7 +25,7 @@ As all user data is kept under `data`, this is the only directory you need to wo
25 25
26- backup the `data` directory 26- backup the `data` directory
27- install or update Shaarli: 27- install or update Shaarli:
28 - fresh installation - see [[Download and installation]] 28 - fresh installation - see [Download and installation](Download and installation)
29 - update - see the following sections 29 - update - see the following sections
30- check or restore the `data` directory 30- check or restore the `data` directory
31 31
@@ -33,11 +33,11 @@ As all user data is kept under `data`, this is the only directory you need to wo
33 33
34All tagged revisions can be downloaded as tarballs or ZIP archives from the [releases](https://github.com/shaarli/Shaarli/releases) page. 34All tagged revisions can be downloaded as tarballs or ZIP archives from the [releases](https://github.com/shaarli/Shaarli/releases) page.
35 35
36We recommend that you use the latest release tarball with the `-full` suffix. It contains the dependencies, please read [[Download and installation]] for `git` complete instructions. 36We recommend that you use the latest release tarball with the `-full` suffix. It contains the dependencies, please read [Download and installation](Download and installation) for `git` complete instructions.
37 37
38Once downloaded, extract the archive locally and update your remote installation (e.g. via FTP) -be sure you keep the content of the `data` directory! 38Once downloaded, extract the archive locally and update your remote installation (e.g. via FTP) -be sure you keep the content of the `data` directory!
39 39
40After upgrading, access your fresh Shaarli installation from a web browser; the configuration and data store will then be automatically updated, and new settings added to `data/config.json.php` (see [[Shaarli configuration]] for more details). 40After upgrading, access your fresh Shaarli installation from a web browser; the configuration and data store will then be automatically updated, and new settings added to `data/config.json.php` (see [Shaarli configuration](Shaarli configuration) for more details).
41 41
42## Upgrading with Git 42## Upgrading with Git
43 43
@@ -170,7 +170,7 @@ Total 3317 (delta 2050), reused 3301 (delta 2034)to
170 170
171#### Step 3: configuration 171#### Step 3: configuration
172 172
173After migrating, access your fresh Shaarli installation from a web browser; the configuration will then be automatically updated, and new settings added to `data/config.php` (see [[Shaarli configuration]] for more details). 173After migrating, access your fresh Shaarli installation from a web browser; the configuration will then be automatically updated, and new settings added to `data/config.php` (see [Shaarli configuration](Shaarli configuration) for more details).
174 174
175## Troubleshooting 175## Troubleshooting
176 176