From 0433c688b9be6097b85a8fec31b3dacd0ab81677 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sun, 18 Jun 2017 06:32:30 +0200 Subject: make htmlpages --- doc/md/Browsing-and-searching.md | 2 +- doc/md/Community-&-Related-software.md | 2 +- doc/md/Continuous-integration-tools.md | 8 ++++---- doc/md/Development-guidelines.md | 6 +++--- doc/md/Firefox-share.md | 2 +- doc/md/GnuPG-signature.md | 2 +- doc/md/Theming.md | 4 ++-- doc/md/Upgrade-and-migration.md | 10 +++++----- 8 files changed, 18 insertions(+), 18 deletions(-) (limited to 'doc/md') 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. ## Filtering RSS feeds/Picture wall -RSS feeds can also be restricted to only return items matching a text/tag search: see [[RSS feeds]]. +RSS 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 ### Themes -See [[Theming]] for the list of community-contributed themes, and an installation guide. +See [Theming](Theming) for the list of community-contributed themes, and an installation guide. ### Server apps - [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 @@ ## Local development A [`Makefile`](https://github.com/shaarli/Shaarli/blob/master/Makefile) is available to perform project-related operations: - Documentation - generate a local HTML copy of the GitHub wiki -- [[Static analysis]] - check that the code is compliant to PHP conventions -- [[Unit tests]] - ensure there are no regressions introduced by new commits +- [Static analysis](Static analysis) - check that the code is compliant to PHP conventions +- [Unit tests](Unit tests) - ensure there are no regressions introduced by new commits ## Automatic builds [Travis CI](http://docs.travis-ci.com/) is a Continuous Integration build server, that runs a build: - each time a commit is merged to the mainline (`master` branch) - each time a Pull Request is submitted or updated -A build is composed of several jobs: one for each supported PHP version (see [[Server requirements]]). +A build is composed of several jobs: one for each supported PHP version (see [Server requirements](Server requirements)). Each build job: - updates Composer - installs 3rd-party test dependencies with Composer -- runs [[Unit tests]] +- runs [Unit tests](Unit tests) After all jobs have finished, Travis returns the results to GitHub: - 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 @@ Please have a look at the following pages: - [Contributing to Shaarli](https://github.com/shaarli/Shaarli/tree/master/CONTRIBUTING.md) -- [[Static analysis]] - patches should try to stick to the [PHP Standard Recommendations](http://www.php-fig.org/psr/) (PSR), especially: +- [Static analysis](Static analysis) - patches should try to stick to the [PHP Standard Recommendations](http://www.php-fig.org/psr/) (PSR), especially: - [PSR-1](http://www.php-fig.org/psr/psr-1/) - Basic Coding Standard - [PSR-2](http://www.php-fig.org/psr/psr-2/) - Coding Style Guide -- [[Unit tests]] -- [[GnuPG signature]] for tags/releases +- [Unit tests](Unit tests) +- [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 @@ ### Sharing links using Firefox share * Add the sharing service as described above - * When you are visiting a webpage you would like to share with Shaarli, click the Firefox _Share_ button [[images/firefoxshare.png]] + * When you are visiting a webpage you would like to share with Shaarli, click the Firefox _Share_ button [images/firefoxshare.png](images/firefoxshare.png) * You can edit your link before and after saving, just like the bookmarklet above. |  | 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 ## Create and push a GPG-signed tag -See [[Release Shaarli]]. +See [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 **Note**: Do not edit `tpl/default/css/shaarli.css`! Your changes would be overridden when updating Shaarli. -See also [[Download CSS styles from an OPML list]] +See also [Download CSS styles from an OPML list](Download CSS styles from an OPML list) ## Themes @@ -77,7 +77,7 @@ Get config written: - fill the install form - log in to Shaarli -Edit Shaarli's [[configuration|Shaarli configuration]]: +Edit Shaarli's [configuration|Shaarli configuration](configuration|Shaarli configuration): ```bash # the file should be owned by Apache, thus not writeable => sudo $ 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: - `data/ipbans.php` - banned IP addresses - `data/updates.txt` - contains all automatic update to the configuration and datastore files already run -See [[Shaarli configuration]] for more information about Shaarli resources. +See [Shaarli configuration](Shaarli configuration) for more information about Shaarli resources. It is recommended to backup this repository _before_ starting updating/upgrading Shaarli: - 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 - backup the `data` directory - install or update Shaarli: - - fresh installation - see [[Download and installation]] + - fresh installation - see [Download and installation](Download and installation) - update - see the following sections - check or restore the `data` directory @@ -33,11 +33,11 @@ As all user data is kept under `data`, this is the only directory you need to wo All tagged revisions can be downloaded as tarballs or ZIP archives from the [releases](https://github.com/shaarli/Shaarli/releases) page. -We 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. +We 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. Once downloaded, extract the archive locally and update your remote installation (e.g. via FTP) -be sure you keep the content of the `data` directory! -After 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). +After 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). ## Upgrading with Git @@ -170,7 +170,7 @@ Total 3317 (delta 2050), reused 3301 (delta 2034)to #### Step 3: configuration -After 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). +After 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). ## Troubleshooting -- cgit v1.2.3