mirror of
https://github.com/wallabag/wallabag.git
synced 2025-01-24 23:58:13 +00:00
Add documentation about article sharing
This commit is contained in:
parent
05d2d62f12
commit
8fed8d1bac
10 changed files with 64 additions and 17 deletions
|
@ -10,15 +10,14 @@ More informations on our website: [wallabag.org](https://wallabag.org)
|
||||||
|
|
||||||
# Install wallabag
|
# Install wallabag
|
||||||
|
|
||||||
If you don't have it yet, please [install composer](https://getcomposer.org/download/) or be sure to use Composer 1.2 (`composer selfupdate` can help you about that).
|
If you don't have it yet, please [install composer](https://getcomposer.org/download/) or be sure to use Composer 1.2 (`composer selfupdate` can help you about that). Read [our documentation](http://doc.wallabag.org) to have more information about installation.
|
||||||
Then you can install wallabag by executing the following commands:
|
Then you can install wallabag by executing the following commands:
|
||||||
|
|
||||||
```
|
```
|
||||||
git clone https://github.com/wallabag/wallabag.git
|
git clone https://github.com/wallabag/wallabag.git
|
||||||
cd wallabag
|
cd wallabag
|
||||||
git checkout 2.0.8
|
git checkout 2.1
|
||||||
SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
|
./install.sh
|
||||||
php bin/console wallabag:install --env=prod
|
|
||||||
php bin/console server:run --env=prod
|
php bin/console server:run --env=prod
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
@ -30,7 +30,7 @@ framework:
|
||||||
assets: ~
|
assets: ~
|
||||||
|
|
||||||
wallabag_core:
|
wallabag_core:
|
||||||
version: 2.0.8
|
version: 2.1
|
||||||
paypal_url: "https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9UBA65LG3FX9Y&lc=gb"
|
paypal_url: "https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9UBA65LG3FX9Y&lc=gb"
|
||||||
languages:
|
languages:
|
||||||
en: 'English'
|
en: 'English'
|
||||||
|
|
|
@ -46,7 +46,7 @@ Composer installieren:
|
||||||
|
|
||||||
curl -s http://getcomposer.org/installer | php
|
curl -s http://getcomposer.org/installer | php
|
||||||
|
|
||||||
Du kannst eine spezifische Anleitung `hier <https://getcomposer.org/doc/00-intro.md>`__ finden:
|
Du kannst eine spezifische Anleitung `hier <https://getcomposer.org/doc/00-intro.md>`__ finden.
|
||||||
|
|
||||||
Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen:
|
Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen:
|
||||||
|
|
||||||
|
|
|
@ -40,6 +40,7 @@ The documentation is available in other languages:
|
||||||
user/errors_during_fetching
|
user/errors_during_fetching
|
||||||
user/annotations
|
user/annotations
|
||||||
user/download_articles
|
user/download_articles
|
||||||
|
user/share
|
||||||
user/filters
|
user/filters
|
||||||
user/tags
|
user/tags
|
||||||
user/android
|
user/android
|
||||||
|
|
|
@ -37,7 +37,7 @@ Installation
|
||||||
On a dedicated web server (recommended way)
|
On a dedicated web server (recommended way)
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
wallabag uses a large number of libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``).
|
wallabag uses a large number of PHP libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``).
|
||||||
|
|
||||||
Install Composer:
|
Install Composer:
|
||||||
|
|
||||||
|
@ -45,7 +45,14 @@ Install Composer:
|
||||||
|
|
||||||
curl -s http://getcomposer.org/installer | php
|
curl -s http://getcomposer.org/installer | php
|
||||||
|
|
||||||
You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__:
|
You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__.
|
||||||
|
|
||||||
|
You also need to install node.js (via `the Download page <https://nodejs.org/en/download/>`__), npm (already install with node.js), bower and grunt:
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
npm install -g bower
|
||||||
|
npm install -g grunt-cli
|
||||||
|
|
||||||
To install wallabag itself, you must run the following commands:
|
To install wallabag itself, you must run the following commands:
|
||||||
|
|
||||||
|
@ -53,9 +60,8 @@ To install wallabag itself, you must run the following commands:
|
||||||
|
|
||||||
git clone https://github.com/wallabag/wallabag.git
|
git clone https://github.com/wallabag/wallabag.git
|
||||||
cd wallabag
|
cd wallabag
|
||||||
git checkout 2.0.8
|
git checkout 2.1
|
||||||
SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
|
./install.sh
|
||||||
php bin/console wallabag:install --env=prod
|
|
||||||
|
|
||||||
To start PHP's build-in server and test if everything did install correctly, you can do:
|
To start PHP's build-in server and test if everything did install correctly, you can do:
|
||||||
|
|
||||||
|
|
17
docs/en/user/share.rst
Normal file
17
docs/en/user/share.rst
Normal file
|
@ -0,0 +1,17 @@
|
||||||
|
Share articles
|
||||||
|
==============
|
||||||
|
|
||||||
|
When you're reading an article, you can share it. Just click on the share button:
|
||||||
|
|
||||||
|
.. image:: ../../img/user/share.png
|
||||||
|
:alt: share article
|
||||||
|
:align: center
|
||||||
|
|
||||||
|
Now, you can share the article:
|
||||||
|
|
||||||
|
- with a public URL (you'll have a light view of the article)
|
||||||
|
- with a tweet
|
||||||
|
- into your Shaarli
|
||||||
|
- with a post in Diaspora*
|
||||||
|
- to Carrot
|
||||||
|
- with an email
|
|
@ -41,6 +41,7 @@ La documentation est disponible dans d'autres langues :
|
||||||
user/errors_during_fetching
|
user/errors_during_fetching
|
||||||
user/annotations
|
user/annotations
|
||||||
user/download_articles
|
user/download_articles
|
||||||
|
user/share
|
||||||
user/filters
|
user/filters
|
||||||
user/tags
|
user/tags
|
||||||
|
|
||||||
|
|
|
@ -35,7 +35,7 @@ Installation
|
||||||
Sur un serveur dédié (méthode conseillée)
|
Sur un serveur dédié (méthode conseillée)
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
wallabag utilise un grand nombre de bibliothèques pour fonctionner. Ces bibliothèques doivent être installées à l'aide d'un outil nommé Composer. Vous devez l'installer si ce n'est déjà fait et vous assurer que vous utilisez bien la version 1.2 (si vous avez déjà Composer, faite un ``composer selfupdate``).
|
wallabag utilise un grand nombre de bibliothèques PHP pour fonctionner. Ces bibliothèques doivent être installées à l'aide d'un outil nommé Composer. Vous devez l'installer si ce n'est déjà fait et vous assurer que vous utilisez bien la version 1.2 (si vous avez déjà Composer, faite un ``composer selfupdate``).
|
||||||
|
|
||||||
Installation de Composer :
|
Installation de Composer :
|
||||||
|
|
||||||
|
@ -43,17 +43,23 @@ Installation de Composer :
|
||||||
|
|
||||||
curl -s http://getcomposer.org/installer | php
|
curl -s http://getcomposer.org/installer | php
|
||||||
|
|
||||||
Vous pouvez trouver des instructions spécifiques `ici (en anglais) <https://getcomposer.org/doc/00-intro.md>`__ :
|
Vous pouvez trouver des instructions spécifiques `ici (en anglais) <https://getcomposer.org/doc/00-intro.md>`__.
|
||||||
|
|
||||||
Pour installer wallabag, vous devez exécuter ces deux commandes :
|
Vous devez aussi installer node.js (via `la page de téléchargements <https://nodejs.org/en/download/>`__), npm (déjà installé avec node.js), bower et grunt:
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
npm install -g bower
|
||||||
|
npm install -g grunt-cli
|
||||||
|
|
||||||
|
Pour installer wallabag, vous devez exécuter ces commandes :
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
git clone https://github.com/wallabag/wallabag.git
|
git clone https://github.com/wallabag/wallabag.git
|
||||||
cd wallabag
|
cd wallabag
|
||||||
git checkout 2.0.8
|
git checkout 2.1
|
||||||
SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
|
./install.sh
|
||||||
php bin/console wallabag:install --env=prod
|
|
||||||
|
|
||||||
Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter :
|
Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter :
|
||||||
|
|
||||||
|
|
17
docs/fr/user/share.rst
Normal file
17
docs/fr/user/share.rst
Normal file
|
@ -0,0 +1,17 @@
|
||||||
|
Partager des articles
|
||||||
|
=====================
|
||||||
|
|
||||||
|
Quand vous lisez un article, vous pouvez le partager. Cliquez sur le bouton de partage :
|
||||||
|
|
||||||
|
.. image:: ../../img/user/share.png
|
||||||
|
:alt: partager un article
|
||||||
|
:align: center
|
||||||
|
|
||||||
|
Vous pouvez maintenant le partager :
|
||||||
|
|
||||||
|
- avec une URL publique (vous obtiendrez une vue allégée de l'article)
|
||||||
|
- avec un tweet
|
||||||
|
- dans votre Shaarli
|
||||||
|
- avec un message dans Diaspora*
|
||||||
|
- sur Carrot
|
||||||
|
- avec un email
|
BIN
docs/img/user/share.png
Normal file
BIN
docs/img/user/share.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 9.2 KiB |
Loading…
Reference in a new issue