Équivalent à "Read the docs"

L'auteur de ce sujet a trouvé une solution à son problème.
Staff
Auteur du sujet

Bonjour,

Afin de faire une base de documentation sur un réseau local, je me demandais si vous connaissez un équivalent à "Read the docs" dont les caractéristiques seraient :

  • léger (genre un truc en PHP sur base MySQL)
  • doc rédigée 100% à la main (c'est pas pour une documentation de code ni de projet)
  • rédaction en markdown
  • interface très simple : menu arborescent, zone de recherche et c'est tout.

Alors OK, un WordPress peut faire l'affaire, mais j'aimerais vraiment un truc hyper léger.

Llama ◦ FAQ PHPTuto WAMP

+0 -0
Staff

Si tu te relaxe sur le coté "markdown", tu peux utiliser sphinx qui est en fait la base de ReadTheDocs. Ça te fournit depuis tes sources du html donc tu n'as meme pas besoin de langages coté serveur.

ReadTheDocs propose d'utiliser MkDocs pour faire des docs en markdown.

Enfin sache qu'il doit être possible d'utiliser markdown directement avec sphinx mais ça demande de lui ajouter le parseur.

+1 -0
Staff

Bin en fait ça dépend. Que ce soit MkDocs ou Sphinx, ça génère du html. Tu a le processus de build qui utilise Python mais une fois construit, tu n'a pas plus besoin de python.

Je doute que Python seul utilisé uniquement pour le build puis accès à la doc de manière statique soit plus lourd qu'un PHP+MySql.

Dans le même ordre d'idée Pandoc peut te générer, depuis le markdown, du html. Avec un template (qu'il peut gérer aussi), tu peux avoir ton doc facile.

+1 -0

Wikitten ? Pas sûr que sa convienne, je ne sais pas si tu souhaites rédiger directement sur le site.

It goes against the grain of modern education to teach children to program. What fun is there in making plans, acquiring discipline in organizing thoughts, devoting attention to detail and learning to be self-critical? – Perlis

+0 -0

Note : à mon avis t'emmerdes pas avec une base de données, si ? T'as vraiment un gros besoin d'indexation derrière ? Avec un système de fichiers plats t'as un import / export tout prêt, t'es pas dépendant d'une config/install (pour redistribuer c'est pas négligeable).

Quitte à "brancher" par-dessus un moteur d'indexation par la suite ? Ca peut-être un design intéressant. Bon courage en tout cas j'espère que ça donnera un résultat sympa !

Happiness is a warm puppy

+0 -0
Staff
Auteur du sujet

En fait, je veux un bon système de recherche. C'est vraiment le nerf de guerre, Une base de connaissances avec un moteur de recherche foireux, ça sert à rien.

Je pensais à la base à la recherche fulltext de MySQL, qui donne des résultats par trop mal. Mais effectivement, je ne sait pas trop sur quoi me baser. Tu as quelques pistes intéressantes ?

Édité par elyppire

Llama ◦ FAQ PHPTuto WAMP

+0 -0
Staff

J'ai jamais travaillé avec FULLTEXT de MySQL, mais récemment j'ai mis en place un truc en PHP qui passe par un bête exec('grep') avec les bons paramètres.

Ça permet de stocker les documents au format MarkDown, et d'avoir un cache en HTML pour les performances. Je songe d'ailleurs à garder une version texte pure pour une recherche plus précise.

Au final : pas de BDD, que des fichiers lisibles et utilisation des fonctionnalités de l'OS (principal inconvénient du coup : aucune idée du résultat sur Windows). Du coup ça permet un export super simple (un bon vieux zip du dossier principal et le tour est joué) et aucune configuration ou presque.

Staff
Auteur du sujet

Oui, ça pourrait aussi faire, j'y ai pensé au grep, mais je ne voudrais pas me conditionner trop à l'environnement Unix.

Autre chose je souhaite quand même un système de catégories léger (genre Informatique - Comptabilité - Expéditions - Sécurité - etc.) et j'ai peur de me compliquer la tâche en travaillant en No SQL (comment facilement stocker mes catégories ? Dans des dossiers ?)

Enfin de toute façon j'expérimente, mon projet est tellement léger que je peux facilement changer de direction (actuellement j'ai presque fini et je dois avoir à tout casser 1k de lignes de code).

Mais merci pour vos retours, ça permet de découvrir plein de choses :)

Llama ◦ FAQ PHPTuto WAMP

+0 -0
Staff

Tu sais que NoSQL = Not Only SQL ? Du coup tu peux faire des requêtes (souvent basiques), par exemple avec MongoDB.

Sinon tu peux utiliser un système de dossiers, ou tout bêtement lire un JSON à chaque fichier MD qui contient les métadonnées (ou encore plus bête, les stocker dans un commentaire en début de fichier).

Vous devez être connecté pour pouvoir poster un message.
Connexion

Pas encore inscrit ?

Créez un compte en une minute pour profiter pleinement de toutes les fonctionnalités de Zeste de Savoir. Ici, tout est gratuit et sans publicité.
Créer un compte