Retour à l'accueil

Opensophy Hub : SSG/SPA pour la documentation Markdown

Opensophy Hub — plateforme open-source pour créer des sites web de documentation technique basée sur Markdown étendu. Navigation automatique à partir de la structure de fichiers, tableaux interactifs et UI-playgrounds simplifient la publication de contenu. Éditeur CMS intégré avec live-preview accélère le flux de travail des développeurs.

Opensophy Hub : Markdown puissant pour la documentation IT
Advertisement 728x90

Opensophy Hub : Plateforme SSG/SPA statique pour la documentation Markdown avancée

Opensophy Hub est une plateforme hybride SSG et SPA conçue pour publier de la documentation technique, des articles et des manuels. Elle résout le défi de stocker du contenu avec des capacités Markdown avancées sans avoir besoin de MDX ou de plugins supplémentaires. La structure du projet est générée directement à partir du système de fichiers dans le répertoire Docs/, où les dossiers définissent la navigation : barre latérale, fil d'Ariane et URLs sont créés automatiquement.

Exemple de structure :

Docs/
├── welcome.md
├── [N][brain]Articles{article}/
│   ├── [C][folder-code]Development{development}/
│   │   └── [A][layers]Stack Selection{webrendering}.md
│   └── [C][signal]Tools{tools}/
│       └── [A][container]Dokploy Overview{dokploy}.md

Trois niveaux de hiérarchie — sections ([N]), catégories ([C]), articles ([A]) — fournissent des slugs, des icônes et des titres sans configuration manuelle de routage. Cela simplifie la maintenance et l'évolutivité du contenu pour les développeurs intermédiaires/seniors.

Google AdInline article slot

Markdown avancé sans dépendances

Hub introduit des blocs riches directement dans les fichiers .md standards : alertes, cartes, colonnes, steppers, diagrammes, formules KaTeX et graphiques à partir de tableaux. Au lieu d'un markup HTML avec des classes, il utilise des constructions syntaxiques simples.

Exemple d'alerte en HTML :

<div class="alert alert-warning" role="alert">
  <strong>Ostorozhno!</strong> Udalyonnye cherez <code>rm</code> files not popadayut in korzinu.
</div>

Dans Hub :

Google AdInline article slot
:::caution
Files deleted with `rm` don't go to the trash.
:::

Instruction pas à pas (stepper) :

:::steps
:::step[status=done] Installation
`npm install`
:::
:::step[status=active] Setup
Fill out `.env`.
:::
:::step[status=pending] Launch
`npm run dev`
:::
:::

Ces blocs s'affichent nativement sans bibliothèques externes, réduisant la complexité de la construction et améliorant les performances en mode SPA.

Tableaux interactifs et aires de jeu UI

Les tableaux Markdown standards se transforment en composants interactifs avec filtres de colonnes (multisélection), recherche avec surlignage, masquage de colonnes, plein écran, défilement par glisser-déposer et export vers Markdown/Excel.

Google AdInline article slot

Il prend également en charge l'intégration de composants de bibliothèque UI en direct avec une seule ligne :

[uic:blur-text]

Les utilisateurs peuvent ajuster dynamiquement les paramètres — échelle, couleur, animation, vitesse — et voir les résultats en temps réel. Parfait pour démontrer des composants dans la documentation sans aire de jeu séparée.

Panneau CMS pour l'édition

Le panneau de gestion de contenu intégré permet d'éditer le Markdown avec aperçu en direct. Créez des pages, catégories et sections directement dans l'interface — pas besoin de redémarrer npm run dev ou d'exécuter des scripts. Le support complet des formats de blocs offre un flux de travail comme un CMS complet, mais alimenté par génération statique.

Avantages pour les développeurs :

  • Navigation automatique à partir de la structure de fichiers.
  • Markdown avancé sans plugins ni MDX.
  • Tableaux interactifs avec filtres et export.
  • Aires de jeu en direct pour composants UI.
  • Éditeur de type CMS avec aperçu.

Ce qui compte

  • Structure de fichiers comme navigation : Automatisation complète du routage, fil d'Ariane et barre latérale à partir des préfixes [N], [C], [A].
  • Blocs Markdown natifs : Alertes, steppers, colonnes, KaTeX, graphiques — sans dépendances.
  • Interactivité des tableaux : Filtres, recherche, plein écran, export vers MD/Excel.
  • Aires de jeu UI : Une ligne pour des démos de composants en direct avec paramètres.
  • Interface CMS : Édition avec aperçu, sans construction requise.

— Editorial Team

Advertisement 728x90

Lire ensuite