Skip to content

Instantly share code, notes, and snippets.

@MachinisteWeb
Created March 1, 2016 08:42
Show Gist options
  • Save MachinisteWeb/eeb7bdac530e3b4e9502 to your computer and use it in GitHub Desktop.
Save MachinisteWeb/eeb7bdac530e3b4e9502 to your computer and use it in GitHub Desktop.
StackEdit.io - Document de bienvenue
Bienvenue sur StackEdit ! {#bienvenue}
=========================
Salut, Je suis votre premier document français dans **StackEdit**[^stackedit]. Ne m'effacez pas, je peux vous aider. Je peux être retrouvé sur [blog.lesieur.name](http://blog.lesieur.name). Ma version anglaise peux également être trouvé dans l'onglet `Utils` de la fenêtre <i class="icon-cog"></i> `Settings`.
----------
Documents
---------
**StackEdit** stoque vos documents dans votre navigateur, cela signifie que tous vos documents sont automatiquement sauvés localement et sont accessibles **hors connexion !**
> **NOTE :**
>
> - StackEdit est accessible hors ligne après que l'application ai été chargée une première fois.
> - Vos documents locaux ne sont pas partagé entre vos différents navigateurs ou ordinateurs.
> - Nettoyer le cache de votre navigateur peut **effacer tous vos documents en local !** Soyez sure que vos documents sont sauvegardé en utilisant une synchronisation **Google Drive** ou **Dropbox** (voir la section [<i class="icon-share"></i> Synchronisation](#synchronisation)).
#### <i class="icon-file"></i> Créer un document
Vous pouvez créer un document en cliquant sur le bouton <i class="icon-file"></i> dans la barre de navigation. Il vous basculera du document courant vers le nouveau.
#### <i class="icon-folder-open"></i> Basculer vers un autre document
Vous pouvez lister tous vos documents locaux et basculer de l'un à l'autre en cliquant sur le bouton <i class="icon-folder-open"></i> dans la barre de navigation.
#### <i class="icon-pencil"></i> Renommer un document
Vous pouvez renommer le document courant en cliquant sur son title dans la barre de navigation.
#### <i class="icon-trash"></i> Effacer un document
Vous pouvez éffacer le document courant en cliquant sur le bouton <i class="icon-trash"></i> dans la barre de navigation.
#### <i class="icon-hdd"></i> Sauver un document
Vous pouvez sauver le document courant dans un fichier en utilisant le sous-menu <i class="icon-hdd"></i> `Save as...` depuis le menu <i class="icon-provider-stackedit"></i>.
> **Conseil :** Rendez-vous dans la section [<i class="icon-share"></i> Publish a document](#publier-un-document) pour une description des différents formats de sortie.
----------
Synchronisation
---------------
**StackEdit** peut être combiné avec **Google Drive** et **Dropbox** pour garder vos documents centralisée dans le *Cloud*. Le mécanisme de synchronisation va prendre soin de sauvegarder vos modifications ou d'obtenir la dernière version de vos documents.
> **NOTE :**
>
> - Un accès complet à **Google Drive** ou **Dropbox** est requis pour permettre l'import de n'importe quel document dans StackEdit.
> - Les documents sont directement importés dans votre navigateur et ne sont pas transmis au serveur.
> - Si vous rencontrez un problème avec l'export de vos documents via Google Drive, vérifiez et désactivez les extensions de votre navigateur, comme Disconnect.
#### <i class="icon-download"></i> Importer un document
Vous pouvez importer un document depuis le *Cloud* en vous rendant dans le sous-menu <i class="icon-provider-gdrive"></i> `Google Drive` ou <i class="icon-provider-dropbox"></i> `Dropbox` et en cliquant sur `Import from...`. Une fois importé, votre document sera automatiquement synchronisé avec le fichier **Google Drive** / **Dropbox**.
#### <i class="icon-upload"></i> Exporter un document
Vous pouvez exporter n'importe quel document en allant dans le sous-menu <i class="icon-provider-gdrive"></i> `Google Drive` ou <i class="icon-provider-dropbox"></i> `Dropbox` et en cliquant sur `Export to...`. Même si votre document est déjà synchronisé avec **Google Drive** ou **Dropbox**, vous pouvez l'exporter à un nouvel endroit. **StackEdit** peut synchroniser un document avec plusieurs sources.
> **Conseil :** Utilisez **Google Drive**, pour créer un document de collabosation pour travailler en temps réel avec d'autres utilisateurs. Il faut juste cocher la case `Create a real time collaborative document` dans la fenêtre des options quand vous exporter un document de Google Drive.
#### <i class="icon-refresh"></i> Synchroniser un document
Une fois que votre document est mapper à un fichier **Google Drive** ou a un fichier **Dropbox**, **StackEdit** va periodiquement (toutes les 3 minutes) synchroniser les modifications. N'importe quel conflit sera détecté, et une copie local de votre document sera créer comme backup si nécessaire.
Si vous venez tout juste de modifier votre document et que vous voulez forcer la synchronisation, cliquez sur le bouton <i class="icon-refresh"></i> de votre barre de navigation.
> **NOTE :** Le bouton <i class="icon-refresh"></i> est désactivé quand votre document n'est pas synchronisé.
#### <i class="icon-refresh"></i> Gérer la synchronisation
Dès qu'un document est synchroniser avec plusieurs sources, vous pouvez lister et manager les sources synchronisés en cliquant sur <i class="icon-refresh"></i> `Manage synchronization` dans le menu <i class="icon-provider-stackedit"></i>. Cela va ouvrir une fenêtre vous permettant d'ajouter et de retirer les fichiers mappés à votre document.
> **NOTE :** Si vous supprimez un fichier depuis **Google Drive** ou depuis **Dropbox**, le document ne sera plus synchronisé avec cette source.
----------
Publication
-----------
Une fois que votre document vous plait, vous pouvez le publier sur différent sites web directement depuis **StackEdit**. Actuellement, **StackEdit** peut publier sur **Blogger**, **Dropbox**, **Gist**, **GitHub**, **Google Drive**, **Tumblr**, **WordPress** et sur n'importe quel serveur SSH.
#### <i class="icon-share"></i> Publier un document
Vous pouvez publier un document en vous rendant dans le sous-menu <i class="icon-share"></i> `Publish on` et en choisissant un site web. Dans la fenêtre, vous pouvez choisir le format de publication :
- Markdown, pour publier le texte Markdown sur un site web qui peut l'interpréter (**GitHub** par exemple),
- HTML, pour publier le document converti en HTML (sur un blog par exemple),
- Template, pour avoir un contrôle total sur la sortie.
> **NOTE :** Le template par defaut est une simple page web qui entoure votre document dans un format HTML. Vous pouvez le customiser dans l'onglet `Services` de la fenêtre <i class="icon-cog"></i> `Settings`.
#### <i class="icon-share"></i> Mettre à jour une publication
Après une publication, **StackEdit** va garder le document mapper mapper à la source de publication pour que vous puissiez la mettre à jour facilement. Une fois que vous avez mis à jour votre publication, cliquez sur le bouton <i class="icon-share"></i> dans la barre de navigation.
> **NOTE :** Le bouton <i class="icon-share"></i> est désactivé quand le document n'a pas encore été publié.
#### <i class="icon-share"></i> Gérer vos publication
Dès qu'un document est publié à divers endroit, vous pouvez lister et gérer les sources de publication en cliquant sur <i class="icon-share"></i> `Manage publication` dans le menu <i class="icon-provider-stackedit"></i>. Cela va ouvrir une une fenêtre qui vous permettra de supprimer des publication mappées à votre document.
> **NOTE :** Dans plusieurs cas, si le fichier a été supprimé du site ou du blog, le document ne sera plus publié pour cette source.
----------
Markdown Extra
--------------
**StackEdit** supporte **Markdown Extra**, qui étend la syntax **Markdown** avec pas mal de bonne fonctionalités.
> **Conseil :** Vous pouvez désactiver **Markdown Extra** depuis l'onglet `Extensions` de la fenêtre <i class="icon-cog"></i> `Settings`.
### Tableaux
**Markdown Extra** a une syntaxe spéciale pour les tableaux :
Item | Value
--------- | -----
Computer | 1600 USD
Phone | 12 USD
Pipe | 1 USD
Vous pouvez également spécifier l'alignement avec un ou deux double point :
| Objet | Valeur | Qté |
| :-------- | --------: | :--: |
| PC | 1600 € | 5 |
| Mobile | 12 € | 12 |
| Câble | 1 € | 234 |
### Liste de définitions
**Markdown Extra** a une syntaxe spéciale pour les listes aussi :
Terme 1
Terme 2
: Définition A
: Définition B
Terme 3
: Définition C
: Définition D
> parti de la définition D
### Bloque de code
Les bloque de code GitHub[^gfm] sont aussi supporté par le colorieur de syntaxe **Prettify** :
```js
// Foo
var bar = 0;
```
> **Conseil :** Pour utiliser **Highlight.js** à la place de **Prettify**, configurez l'extension `Markdown Extra` dans la fenêtre <i class="icon-cog"></i> `Settings`.
### Notes de pied de page
Vous pouvez créer des notes de pied de page comme cela[^footnote].
[^footnote]: Ici se trouve le *texte* de la **Note de pied de page**.
### SmartyPants
SmartyPants converti les caractères ASCII en caracères HTML typographique "intéligents". Par exemple :
| | ASCII | HTML |
|-------------|------------------------------------------|--------------------------------------------|
| Apostrophes | `'N'est-ce pas amusant ?'` | &#8216;N&#8217;est-ce pas amusant ?&#8217; |
| Guillemets | `"N'est-ce pas amusant ?"` | &#8220;N&#8217;est-ce pas amusant ?&#8221; |
| Tirets | `double tiret -- et triple --- ` | double tiret &#8211; et triple &#8212; |
### Table des matières
Vous pouvez insérer une table des matière en utilisant le tag `[TOC]` :
[TOC]
### Commentaires
Habituellement, les commentaires en Markdown sont juste des commentaire HTML normaux. <!-- comme cela -->
**StackEdit** étend les commentaires HTML de façon à produire des commentaires visible et utile dans les documents de travail qui ne se voient pas à la publication. <!--- Ceci est très utile pour collecter de précieux feedback dans un document collaboratif. -->
### MathJax
Vous pouvez écrire des expressions mathématique *LaTeX* en utilisant **MathJax**, comme sur [math.stackexchange.com][1]:
La *Fonction Gamma* satisfait $\Gamma(n) = (n-1)!\quad\forall
n\in\mathbb N$ via l'intégrale d'Euler
$$
\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.
$$
> **Conseil :** Assurez vous d'inclure MathJax dans votre publication pour rendre correctement les expressions mathematique. Votre page/template devrait inclure quelque chose comme :
```
<script type="text/javascript" src="https://stackedit.io/libs/MathJax/MathJax.js?config=TeX-AMS_HTML"></script>
```
> **NOTE :** Vous pouvez trouver plus d'information :
>
> - sur la syntaxe **Markdown** [ici][2],
> - sur l'extension **Markdown Extra** [ici][3],
> - sur les expressions mathématique **LaTeX** [ici][4],
> - sur le colorieur syntaxyque **Prettify** [ici][5],
> - sur le colorieur syntaxyque **Highlight.js** [ici][6].
[^stackedit]: [StackEdit](https://stackedit.io/) est un editeur Markdown sur-fonctionnelle open-source basé sur PageDown, une librarie Markdown utilisée par Stack Overflow et les autres sites Stack Exchange.
[^gfm]: **GitHub Flavored Markdown** (GFM) sont supporté par StackEdit.
[1]: http://math.stackexchange.com/
[2]: http://daringfireball.net/projects/markdown/syntax "Markdown"
[3]: https://github.com/jmcmanus/pagedown-extra "Pagedown Extra"
[4]: http://meta.math.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference
[5]: https://code.google.com/p/google-code-prettify/
[6]: http://highlightjs.org/
-----
> Traduction depuis l'article original [Welcome Document](https://stackedit.io/viewer#!url=https://raw.github.com/benweet/stackedit/master/README.md) par [Bruno Lesieur](http://www.lesieur.name/) [le 28/06/2014]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment