GXS Extension
Extension pour écrire les docs du site GX Studio Docs (les .md de content/, voir BLOCS.md du site).
Ce qu'elle fait
- Coloration des blocs
@tip {, @tabs, réglages title: "...", variables !rose, fonctions @color(...),
blocs custom @rang(...), commentaires --##, {{arguments}}. Les couleurs suivent ton thème VS Code.
Le Markdown reste coloré, même indenté dans les blocs.
- Autocomplétion :
@ : tous les blocs (squelette complet, ex. @tabs avec 2 onglets), les fonctions natives et tes blocs custom
de content/customBlocs.md. Dans @tabs, @tab est proposé en premier.
- Dans
@bloc( : les réglages possibles (obligatoires d'abord), puis leurs valeurs (style, tailles...).
@icon(name: " : toutes les icônes Font Awesome gratuites (lues dans node_modules du site).
link: " : les adresses de toutes les docs de docs.json, dans la langue du fichier.
! : les variables de la doc et de customBlocs.md. {{ dans une @fn : ses arguments.
- Erreurs en direct : le fichier est vérifié pendant que tu écris, avec le vrai code du build
(
lib/*.js du site). Les messages sont exactement ceux de npm run build, à la bonne ligne.
customBlocs.md est vérifié à l'enregistrement (le site le lit sur le disque).
- Survol : doc de chaque bloc et réglage, valeur des variables, aperçu des icônes, arguments des blocs custom.
- Aide aux arguments pour
@rang( et @color( / @format(.
- Couleurs : pastille et sélecteur de couleur sur les
"#F2B66D" ; pastille (dégradé compris) devant !rose.
- Repli des blocs
{ } et des commentaires --##{.
docs.json : vérification et autocomplétion des champs (id, updated, icon, iconColor...).
- Aperçu : bouton en haut à droite d'une doc (ou
Ctrl+Shift+Alt+V). Affiche la vraie page du serveur local
(npm run dev), suit la doc ouverte et se recharge à chaque enregistrement. Si le serveur ne tourne pas,
un bouton le lance dans un terminal.
Les erreurs et l'aperçu marchent pour tout fichier rangé dans un dossier qui contient lib/brace-syntax.js
et content/ (le site). Ailleurs, seules la coloration et l'autocomplétion des blocs de base marchent.
Réglages
| Réglage |
Par défaut |
Effet |
gxdocs.diagnostics.enable |
true |
Erreurs en direct |
gxdocs.diagnostics.delay |
350 |
Attente (ms) après la dernière frappe |
gxdocs.colors.swatches |
true |
Pastilles devant les variables couleur |
gxdocs.preview.url |
http://localhost:3000 |
Adresse du serveur local |
gxdocs.preview.followEditor |
true |
L'aperçu suit la doc ouverte |
gxdocs.preview.devCommand |
npm run dev |
Commande du bouton « Lancer le serveur » |
Commandes : GX Docs: Ouvrir l'aperçu, GX Docs: Recharger l'aperçu, GX Docs: Relancer la vérification des erreurs.
Installer / mettre à jour
npx --yes @vscode/vsce package --allow-missing-repository --skip-license
code --install-extension gxs-extension-0.0.1.vsix
Le journal du vérificateur est dans le panneau Sortie, canal GX Docs.
| |