Greboca  

Suport technique et veille technologique

Aujourd’hui, les grandes entreprises et administrations publiques hésitent entre continuer à utiliser des logiciels propriétaires ou basculer vers les Logiciels Libres. Pourtant, la plupart des logiciels libres sont capables de bien traiter les données issues des logiciels propriétaire, et parfois avec une meilleur compatibilité.

C’est alors la barrière de la prise en main qui fait peur, et pourtant...

Les logiciels libres

L’aspect « Logiciel Libre » permet une évolution rapide et une plus grande participation des utilisateurs. Les aides et tutoriels foisonnent sur Internet ou sont directement inclus dans le logiciel lui-même.

Enfin, les concepteurs sont plus proches des utilisateurs, ce qui rend les logiciels libres plus agréable à utiliser et conviviaux.

Grâce à la disponibilité des logiciels libres, vous trouverez facilement des services de support techniques et la licence n’est plus un frein à l’utilisation de ces logiciels par votre personnel.

Notre support technique concerne essentiellement les logiciels libres, que ce soit sous forme de services ponctuels ou de tutoriels.

Planet Libre  -  nIQnutn : Rédiger en Markdown

 -  Mai 2015 - 

Markdown est un outil de conversion de texte vers HTML pour la rédaction sur le web. Il permet de rédiger le texte dans un format facile à lire et à écrire, puis de le convertir en XHTML (ou HTML) valide.

L'idée n'est pas de créer une syntaxe permettant d'insérer plus facilement les balises HTML. HTML est un format de publication, Markdown est un format de rédaction.

Markdown permet donc de mettre en forme simplement du texte brut et de manière intelligible. Contrairement au HTML et ses balises, on comprend aisément un document formaté en Markdown. C'est simple, clair et rapide pour rédiger un document à publier sur le web. On ne peut pas tout faire avec Markdown mais ça permet de rédiger un contenu complet et structuré (mais on peut mélanger Markdown et HTML sans problème). L'autre avantage est de privilégier le contenu sans se préoccuper de la mise en forme.
L'utilisation de Markdown est recommandé pour écrire des courriels en texte brut.

Voici donc un petit memo pour utiliser Markdown (j'ai volontairement simplifié certains aspects que l'on peut retrouver dans les liens).

Les outils pour rédiger en Markdown

Pour rédiger simplement en Markdown et visualiser en temps réel son contenu, on peut utiliser Geany et son extension Markdown. Pour convertir en HTML on installe simplement le paquet Markdown.

en root
apt-get install geany geany-plugin-markdown markdown

On démarre Geany depuis le menu: Développement > Geany
ou directement depuis le terminal:

en utilisateur
geany &

Il faut d'abord activer l'extension dans Geany. Dans le menu: Outils > Gestionnaire de plugin. Ensuite, activer l'extension Markdown. Il est possible de modifier les préférences d'affichage.

Au cours de la rédaction, on pré-visualise le contenu dans l'onglet Aperçu Markdown.
Les fichiers Markdown portent l'extension .md, .mdml ou .markdown.

Si le formatage n'est pas pris en compte, pensez à vérifier que votre texte est bien structuré.
Le nombre d'espace, l'ajout d'une ligne vide ou un caractère spécial peut empêcher le bon fonctionnement de la conversion vers HTML.

La syntaxe Markdown

On va voir la syntaxe utilisée par Markdown et tout ce qu'il est possible de faire avec. J'ai simplifié certains éléments et il est parfois possible d'utiliser plusieurs syntaxes différentes.

La gestion des titres

Pour mettre en forme un texte, on commence par ajouter des titres pour structurer son texte. Le symbole # permet de définir les niveaux de titres. Le titre de niveau 1 (considéré comme le plus élevé) doit être précédé de #. D'une manière générale, on ajoute autant de # que le niveau du titre voulu.

Markdown
# Titre de niveau 1     
## Titre de niveau 2    
### Titre de niveau 3   
#### Titre de niveau 4
HTML

Titre de niveau 1

Titre de niveau 2

Titre de niveau 3

Titre de niveau 4

Le rendu final:

Titre de niveau 1

Titre de niveau 2

Titre de niveau 3

Titre de niveau 4

La gestion des listes

On peut également ajouter des listes ordonnées (comme la liste des distributions GNU/Linux à tester) ou non ordonnées (comme la liste des OS à ne pas utiliser).

Pour les listes non ordonnées, on utilise * suivi d'un espace.

Markdown
* HTML
* CSS
* PHP
* ...
HTML
HTML CSS PHP ...

Le rendu final:

  • HTML
  • CSS
  • PHP
  • ...

Pour les listes non ordonnées, on utilise un nombre suivi d'un point (ex: 1.).

Markdown
1. Premier
2. Deuxième
3. Troisième
HTML
Premier Deuxième Troisième

Le rendu final:

  1. Premier
  2. Deuxième
  3. Troisième
Les nombres utilisés n'ont pas d'importances et ne sont pas interprétés.

La gestion des liens

Il n'est pas rare de faire référence à différents sites. Pour générer des liens, on a besoin de trois éléments.
Un élément qui sera le texte affiché (ex: nIQnutn), un autre qui sera l'URL (ex: http://blog.niqnutn.com) et optionnellement une description (affiché dans l'info-bulle au survol du lien).

Markdown
[nIQnutn](http://blog.niqnutn.com/ "nIQnutn's blog")
HTML
nIQnutn

Le rendu final:

nIQnutn

On peut aussi l'utiliser pour faire des références internes (comme des sommaires, retour vers le haut de la page, etc.) ou utiliser les chemins relatifs pour accéder à une ressource sur le même serveur.

Markdown
Retour vers le [Haut de page](#top "Top") ou se voir les [Actualités](/index.php?static5).
HTML
  

Retour vers le Haut de page ou voir les Actualités.

Le rendu final:

Retour vers le Haut de page ou voir les Actualités.

Encore plus simple, il est possible de créer des liens automatiquement à partir d'URL.

Markdown

Le rendu final:

http://blog.niqnutn.com/

La même chose est valable pour les adresses mail (avec un encodage de l'adresse mail supplémentaire).

Markdown

Le rendu final:

dontSpam@niqnutn.wolrd

La gestion des images

Pour faire joli, on peut également ajouter des images. La syntaxe est similaire aux liens. On ajoute au début !, puis [Texte à afficher si l'image n'apparait pas], suivi de l'URL de l'image (ex: /path/to/img.jpg) et optionnellement une description (affiché dans l'info-bulle au survol de l'image).

Markdown
![Logo Markdown](/path/to/img.jpg "Markdown")
HTML

Le rendu final:

Logo Markdown
et si l'image n'existe pas:
Logo Markdown
Markdown ne permet pas de définir la taille des images. Dans ce cas, il est possible d'utiliser les tags HTML .

La mise en forme

Pour faciliter la lecture on peut utiliser la mise en forme du texte avec l'utilisation du gras, italique, etc.

Pour mettre le texte en italique, on encadre le texte avec *.

Markdown
*Texte en italique*
HTML
Texte en italique

Le rendu final:

Texte en italique

Pour mettre le texte en gras on encadre le texte avec **.

Markdown
**Texte en gras**
HTML
Texte en gras

Le rendu final:

Texte en gras

Pour insérer un retour à la ligne au sein d'un paragraphe (
), on ajoute deux espaces suivi d'un retour à la ligne.

Markdown
War is peace.  
Freedom is slavery.  
Ignorance is strength.
HTML

War is peace.
Freedom is slavery.
Ignorance is strength.

Le rendu final:

War is peace.
Freedom is slavery.
Ignorance is strength.

Pour ajouter une ligne horizontale, on utilise ***.

Markdown
***
HTML

Le rendu final:


Insérer une citation

Pour les citations il suffit d'ajouter > en début de ligne.

Markdown
> He who controls the past controls the future. He who controls the present controls the past.  
> The best books... are those that tell you what you know already.  
> __George Orwell__, _1984_
HTML

He who controls the past controls the future. He who controls the present controls the past.
The best books... are those that tell you what you know already.
George Orwell, 1984

Le rendu final:

He who controls the past controls the future. He who controls the present controls the past.
The best books... are those that tell you what you know already.
George Orwell, 1984

Pour plus de lisibilité on ajoute > à chaque nouvelle ligne.

Insérer du code

Pour insérer du code (le texte est alors interprété littéralement), on ajoute quatre espaces avant le texte.

Markdown
    apt-get install niqnutn
HTML
apt-get install niqnutn

Le rendu final:

apt-get install niqnutn

Note: tous les caractères seront échappés.

Et un peu de html

Dans le cas ou la syntaxe Markdown ne couvre pas vos besoins, il est possible d'ajouter directement du code HTML. Il sera interprété automatiquement et il n'est pas nécessaire d'indiquer qu'on change de langage.

Markdown
Distribution Nom Version Debian Jessie 8.0
HTML
Distribution Nom Version Debian Jessie 8.0

Le rendu final:

Distribution Nom Version
Debian Jessie 8.0

Caractères d'échappement

Tous les caractères spéciaux sont automatiquement convertis (ex: & devient &). Il faut ajouter \\ pour éviter que certains caractères soient interprétés lors de la conversion.

\\   backslash
`   backtick
*   asterisk
_   underscore
{}  curly braces
[]  square brackets
()  parentheses
#   hash mark
+   plus sign
-   minus sign (hyphen)
.   dot
!   exclamation mark

Convertir un document Markdown

Une fois le document rédigé, on peut le convertir au format HTML.

en utilisateur
markdown /path/to/file/comment-rediger-en-mardown.md

On peut envoyer directement le résultat dans un fichier .html.

en utilisateur
markdown /path/to/file/comment-rediger-en-mardown.md > /tmp/comment-rediger-en-mardown.html

Geany dispose d'un terminal intégré. Il n'est donc pas nécessaire de changer de fenêtre.

Aller plus loin avec Markdown

Il est possible d'utiliser des références lorsque l'on utilise de nombreux liens dans un document. L'utilisation des références permet d'avoir un aperçu final proche de celui d'un navigateur web.
On définit d'une part le texte à afficher: DuckDuckGo est le texte qui sera lisible suivi de 1 qui servira d'identifiant.
D'autre part, on définit les liens: On reprend son identifiant 1, suivi de son URL https://duckduckgo.com/ et optionnellement DuckDuckGo qui sera utilisé comme titre.

Markdown
Il existe de nombreux moteurs de recherches tels que [DuckDuckGo][1], [Qwant][qwant] ou [ixquick][].
[1]: https://duckduckgo.com/ "Moteur de recherche DuckDuckGo"
[qwant]: https://www.qwant.com/ "Moteur de recherche Qwant"
[ixquick]: https://ixquick.com "Moteur de recherche ixquick"
HTML
Il existe de nombreux moteurs de recherches tels que DuckDuckGo, Qwant ou ixquick.

Le rendu final:

Il existe de nombreux moteurs de recherches tels que DuckDuckGo, Qwant ou ixquick.

Il est aussi possible d'utiliser une image comme lien.
Markdown
[![alt](data/img/alien.png "logo")](http://blog.niqnutn.com "nIQnutn's blog")
HTML

alt

Le rendu final:

alt

Il est conseillé de lire la documentation concernant la syntaxe si on souhaite utiliser Markdown plus profondément.
L'imbrication des différents éléments nécessite parfois quelques connaissances et astuces.

Ressources


© 2015 nIQnutn - Tous droits réservés.

Gravatar de nIQnutn
Original post of nIQnutn.Votez pour ce billet sur Planet Libre.

par nIQnutn

Planet Libre

Le Planet sur Linux et les Logiciels Libres

Comète : L’infrastructure technique de Framaspace - Fiat Tux

 -  17 janvier - 

— PermalienOriginal post of Comète.Votez pour ce billet sur Planet Libre.Articles similairesComète : Architecture technique Nextcloud de (...)


Comète : Frigate NVR

 -  Septembre 2024 - 

— PermalienOriginal post of Comète.Votez pour ce billet sur Planet Libre.Articles similairesNicolargo : Streaming depuis la Raspberry Camera (...)


Comète : Configurer un serveur mail sous OpenSMTPD - Vinishor's blog

 -  Août 2024 - 

— PermalienOriginal post of Comète.Votez pour ce billet sur Planet Libre.Articles similairesComète : Ray's Notebook: Computing — OpenSMTPD (...)


Comète : Vinishor sur DN42 - Partie 1 : création et déclaration d'un AS - Vinishor's blog

 -  Août 2024 - 

"DN42 est un réseau décentralisé qui est ouvert à tout le monde et qui a pour objectif de reproduire à petite échelle le fonctionnement d'Internet. Il (...)


Simon Vieille : Gestionnaire de fonds d'écrans pour i3

 -  Août 2024 - 

i3 est tiling window manager pour Linux. Je l'utilise depuis de nombreuses années et j'en suis extrêmement satisfait.Puisqu'il se cantonne à (...)