Shortcode-index
Aperçu#
| Shortcode | Rôle | Utilisation |
|---|---|---|
accessibility-contract | Un contrat d’accessibilité piloté par les données, avec des preuves de contraste dérivées des jetons et des règles système liées. | {{< accessibility-contract >}} |
anchor-index | Une passerelle Markdown vers le composant partagé d’index d’ancrage pour les liens vers des sections de la même page. | {{< anchor-index label="Jump to category:" ariaLabel="Cloud monitoring categories" >}} |
arrow | Une flèche ← ou → en ligne, utilisée comme repère d’annotation à côté d’un terme. | {{< arrow left >}} |
brand-changelog | Un changelog filtré pour le système de marque, rendu depuis data/brand/changelog.yml. | {{< brand-changelog topic="tokens" >}} |
callout | Un encadré. Préférer la syntaxe Markdown > [!NOTE]; celui-ci reste pour archive. | {{< callout type="archive" title="Optional title" >}} |
card | Une carte cliquable avec icône et titre. | {{< card title="Installation" icon="download" href="/docs/installation/" >}} |
cards | Grille adaptative pour un ensemble de card. | {{< cards cols="2" >}} |
code | Un bloc de code avec en-tête de nom de fichier et bouton de copie. | {{< code file="config/deploy.yml" lang="yaml" >}} |
colour-palette | Des cartes de couleurs de marque ou Web avec les noms de jetons, les groupes de rôles et les rapports de contraste WCAG générés. | {{< colour-palette >}} |
colour-system | Un explorateur filtrable des jetons de couleur publics, des valeurs de thème, des alias et des preuves WCAG déclarées. | {{< colour-system >}} |
companion | Un renvoi en haut de page vers une page liée, avec une phrase justifiant le lien. | {{< companion "/blog/rustdesk/self-hosting/" >}} |
component-preview | Un exemple vivant encadré d’un composant ou d’un shortcode dans la documentation. | {{< component-preview >}} |
component-relationship | Un lien d’une interface dépendante vers le parent qui rend son véritable exemple. | {{< component-relationship to="/docs/site-implementation/shortcodes/tabs" >}} |
content-count | Un décompte en ligne tiré des pages Hugo ou des données du site. | {{< content-count key="blog" >}} |
definition | Une infobulle de glossaire, résolue depuis data/series/ref/glossary.yml. | {{< definition "saffron" />}} |
design-process | Un cycle piloté par les données qui lie les étapes du processus de conception à leurs preuves et à leur documentation de gouvernance. | {{< design-process >}} |
design-system-overview | Un aperçu imprimable et piloté par les données des six parties reliées et du flux de ce système de conception. | {{< design-system-overview >}} |
details | Une section repliable. | {{< details title="Why not Kubernetes?" >}} |
documentation-scope | Une ligne de métadonnées compacte qui lie les règles de gouvernance et les détails d’implémentation d’une page. | {{< documentation-scope governance="/docs/site-governance/glossary" implementation="/docs/site-implementation/architecture/glossary-generation" >}} |
emoji | Un émoji recherché par nom dans data/series/ref/emojis.yml. | {{< emoji "warning" >}} |
filetree/container | Conteneur d’arborescence de fichiers; contient des filetree/folder et filetree/file. | {{< filetree/container >}} |
filetree/file | Une entrée de fichier dans un filetree/container. | {{< filetree/file name="site.yml" >}} |
filetree/folder | Une entrée de dossier dans un filetree/container. | {{< filetree/folder name="config" >}} |
filter-row | Une passerelle Markdown vers le composant partagé de rangée de filtres pour les contrôles qui changent les lignes ou éléments visibles. | {{< filter-row ariaLabel="Cloud monitoring categories" >}} |
glossary-table | Un tableau de glossaire triable, rendu depuis data/brand/glossary.yml par défaut. | {{< glossary-table >}} |
implementation-status | Un état d’implémentation documenté et des critères d’acceptation pour une interface spécifiée. | {{< implementation-status >}} |
interface-manifest | Un profil piloté par les données de la page de composant ou de shortcode courante. | {{< interface-manifest >}} |
interface-migration-matrix | Un tableau d’audit généré pour les métadonnées, sources et manifestes des composants. | {{< interface-migration-matrix >}} |
kbd | Une touche de clavier, pour les raccourcis. | {{< kbd >}} |
mermaid | Un diagramme Mermaid rendu à partir d’une définition texte. | {{< mermaid >}} |
missing-index | L’arriéré des pages qui déclarent une liste d’artefacts missing:. | {{< missing-index >}} |
pattern-manifest | Une fiche de preuves pilotée par les données pour la page de motif orienté vers une tâche courante. | {{< pattern-manifest >}} |
pullquote | Une citation mise en exergue. | {{< pullquote >}} |
select | Une passerelle Markdown vers le composant partagé de liste déroulante native. | {{< select id="update-frequency" name="frequency" label="Update frequency" selected="weekly" >}} |
site-status | Une passerelle Markdown vers le composant partagé d’état opérationnel lié. | {{< site-status href="https://status.example.com" label="BHDicaire.com" state="operational" status="Operational" >}} |
steps | Une suite d’étapes numérotées. | {{< steps >}} |
tab | Un panneau dans un groupe tabs. | {{< tab label="Ruby" >}} |
tabs | Un groupe d’onglets; contient des tab. | {{< tabs >}} |
template-preview | Un aperçu visuel compact de l’anatomie d’un gabarit de page documenté. | {{< template-preview kind="landing" >}} |
theme-preview | Un sélecteur local de thème clair ou sombre pour les exemples de documentation. | {{< theme-preview >}} |
timeline | Une chronologie verticale de jalons datés; chaque titre ### est une entrée. | {{% timeline %}} |
token-table | Un tableau généré d’une catégorie de jetons, rendu depuis data/brand/tokens.yml. | {{< token-table category="color" >}} |
tooltip | Une passerelle Markdown vers le composant partagé d’infobulle accessible. | {{< tooltip id="response-time-tip" label="Explain response time" >}} |
version | Une étiquette d’ajout, de modification ou d’obsolescence. | {{< version added="2.1" >}} |
video-embed | Une passerelle Markdown vers le composant partagé d’intégration vidéo différée. | {{< video-embed id="M7lc1UVf-VE" title="YouTube Developers Live: Embedded Web Player Customization" thumbnail="/images/home/ben-speaking-les-affaires-2020.jpg" alt="Benoît H. Dicaire speaking on stage" >}} |
web-analytics-table | Un tableau comparatif triable et filtrable d’outils d’analyse Web, rendu depuis data/til/web_analytics.yml. | {{< web-analytics-table >}} |
Exemple
{{< shortcode-index >}}Quand l’utiliser
Un tableau généré de tous les shortcodes locaux, de leur rôle et de leur exemple d’utilisation.
Implémentation
layouts/shortcodes/shortcode-index.htmlOptions
Ce shortcode ne lit aucun paramètre nommé dans son gabarit.
Manifeste d’interface
- Nature
- Shortcode
- Catégorie
- Données
- Statut
- Implémenté
- Implémentation
- Shortcode:
layouts/shortcodes/shortcode-index.html