16
JUIL

Daux.io - Un générateur de documentation au format markdown

Publié le 16/07/13 à 08h47 par DJo

Daux.io est un outil permettant de générer une plateforme de documentation complète et ergonomique en PHP.

Daux.io est un outil permettant de générer une plateforme de documentation complète et ergonomique en PHP.

Si vous êtes amenés à développer un projet open source ou livrer un projet client, vous devrez forcément créer une documentation d'utilisation de votre projet.

Plutôt que de perdre du temps dans de la mise en page Word ou autre, pourquoi ne pas utiliser un outil de génération de documentation qui permettra à vos utilisateurs finaux une meilleure prise en main.

Daux.io est un outil PHP (pouvant être lancé avec Node.JS / Grunt) permettant de générer une plateforme de documentation web ergonomique et responsive.

Code affiché sur le côté de la description

Du code peut être lié à du contenu et présenté sur le côté droit pour avoir une lecture code + détail. Ou plus simplement, en mode inline:

Plateforme de documentation Responsive

La plateforme comprend de la coloration syntaxique sur les principaux langages de programmation.

L'interface est totalement responsive, elle permettra à vos utilisateurs finaux de consulter la doc même à partir de leur smartphone ou tablette (basé sur Twitter Bootstrap).

Plusieurs thèmes sont disponibles pour skinner l'interface suivant vos goûts, et vous aurez aussi la possibilité de créer le votre en quelques lignes de code.

Le contenu de la documentation devra être rédigé au format Markdown (compatible Github flavored Markdown) dans un répertoire docs/.

Une plateforme bien pratique qui pourra être référencée sur les moteurs de recherche et partagée sur les réseaux sociaux.

Pour fonctionner, il faudra toutefois disposer d'un serveur avec PHP 5.4 ou plus.

 

Site Officiel

Baraguiné par Klaiitos le 16/07/13 à 10h08
Klaiitos via Twitter
Ca à l'air tres puissant, mais PHP 5.4 c'est un peu élevé comme prérequis dommage !
Baraguiné par le 17/07/13 à 17h18
5.4, élevé ? Pas nécessairement. :a sortie de PHP 5.4 ne date pas de hier. La plupart des hébergeurs ne font pas la mise à jour tant qu'elle n'est pas demandée... mais souvent suffit de les aviser et ils la feront.

Ajouter un Commentaire

Pour poster un commentaire, vous devez être identifié. Vous pouvez choisir parmi ces trois méthodes d'identification:

Compte la Ferme du Web

Identifiez-vous
Inscrivez-vous

Compte Facebook

Connexion avec Facebook

Compte Twitter

Connexion avec votre compte twitter
Rechercher sur la Ferme du web