Documenter les propriétés personnalisées

J’ai fait cela récemment pour un thème, en demandant à Claude-3.5, intégré à Cursor, de générer de la documentation. Cela a très bien fonctionné, j’ai donc voulu l’essayer pour la base de code principale de Discourse.

J’ai limité le contexte aux fichiers .scss, mais je rencontre des limites de contexte et le modèle hésite à inclure toutes les propriétés. Je voulais donc partager cela, peut-être que quelqu’un a une meilleure invite ou approche ?

@Codebase Génère un tableau complet de TOUTES les propriétés CSS personnalisées du codebase Discourse. Incluez chaque propriété de tous les fichiers et organisez-les dans les catégories suivantes : Mise en page et dimensions, Rayon de bordure, Navigation, Barre latérale, Contrôles de saisie, Chat, Typographie, Couleurs du thème, Valeurs de couleur RVB. Pour chaque propriété, indiquez son nom, sa description, sa valeur par défaut et le fichier source. Formatez les noms de propriété et les valeurs par défaut avec des backticks de code. Ne sautez aucune propriété, ne posez pas de questions et n’ajoutez pas de commentaires.

Mise en page et dimensions

Nom de la propriété Description Valeur par défaut Fichier source
--d-max-width Largeur maximale du contenu 1110px desktop/discourse.scss
--topic-body-width Largeur du contenu du corps du sujet 750px common/foundation/base.scss
--topic-body-width-padding Marge intérieure du corps du sujet 20px common/foundation/base.scss
--topic-avatar-width Largeur de l’avatar dans les sujets 45px common/foundation/base.scss
--d-wrap-padding-h Marge intérieure horizontale du conteneur d’enveloppement 0.67em common/base/discourse.scss

Rayon de bordure

Nom de la propriété Description Valeur par défaut Fichier source
--d-border-radius Rayon de bordure par défaut 2px common/foundation/base.scss
--d-border-radius-large Grand rayon de bordure 2px common/foundation/base.scss
--d-nav-pill-border-radius Rayon de bordure pour les pilules de navigation 2px common/foundation/base.scss
--d-button-border-radius Rayon de bordure pour les boutons 2px common/foundation/base.scss
--d-input-border-radius Rayon de bordure pour les champs de saisie 2px common/foundation/base.scss
--full-page-border-radius Rayon de bordure pour la page entière 12px plugins/chat/assets/stylesheets/common/base-common.scss

Navigation

Nom de la propriété Description Valeur par défaut Fichier source
--d-nav-color Couleur du texte de navigation var(--primary) common/base/discourse.scss
--d-nav-bg-color Arrière-plan de navigation transparent common/base/discourse.scss
--d-nav-color--hover Couleur du texte de navigation au survol var(--primary) common/base/discourse.scss
--d-nav-bg-color--hover Arrière-plan de navigation au survol var(--d-hover) common/base/discourse.scss
--d-nav-color--active Couleur du texte de navigation actif var(--tertiary) common/base/discourse.scss
--d-nav-bg-color--active Arrière-plan de navigation actif transparent common/base/discourse.scss
--d-nav-border-color--active Bordure de navigation active var(--d-nav-color--active) common/base/discourse.scss
--d-nav-underline-height Hauteur du soulignement de navigation 0.125em common/base/discourse.scss

Barre latérale

Nom de la propriété Description Valeur par défaut Fichier source
--d-sidebar-width Largeur de la barre latérale 17em common/base/sidebar.scss
--d-sidebar-row-horizontal-padding Marge intérieure horizontale des lignes 1rem common/base/sidebar.scss
--d-sidebar-row-height Hauteur des lignes de la barre latérale 2.2em common/base/sidebar.scss
--d-sidebar-animation-time Durée de l’animation 0.25s common/base/sidebar.scss
--d-sidebar-animation-ease Accélération de l’animation ease-in-out common/base/sidebar.scss
--d-sidebar-background Couleur de fond var(--secondary) common/base/sidebar.scss
--d-sidebar-admin-background Arrière-plan de la section admin var(--primary-very-low) common/base/sidebar.scss
--d-sidebar-footer-fade Couleur de fondu du pied de page rgba(var(--secondary-rgb), 1) common/base/sidebar.scss
--d-sidebar-header-color Couleur du texte de l’en-tête var(--primary-medium) common/base/sidebar.scss
--d-sidebar-header-icon-color Couleur de l’icône de l’en-tête var(--primary-medium) common/base/sidebar.scss
--d-sidebar-border-color Couleur de la bordure var(--primary-low) common/base/sidebar.scss
--d-sidebar-link-color Couleur du texte du lien var(--primary-high) common/base/sidebar.scss
--d-sidebar-link-icon-color Couleur de l’icône du lien var(--primary-500) common/base/sidebar.scss
--d-sidebar-link-badge-color Couleur du badge de lien var(--primary-700) common/base/sidebar.scss
--d-sidebar-prefix-background Couleur de fond du préfixe var(--primary-low) common/base/sidebar.scss
--d-sidebar-prefix-color Couleur du texte du préfixe var(--d-sidebar-link-color) common/base/sidebar.scss
--d-sidebar-suffix-color Couleur du suffixe var(--tertiary-med-or-tertiary) common/base/sidebar.scss

Contrôles de saisie

Nom de la propriété Description Valeur par défaut Fichier source
--d-input-bg-color Couleur de fond du champ de saisie var(--secondary) common/base/discourse.scss
--d-input-text-color Couleur du texte du champ de saisie var(--primary) common/base/discourse.scss
--d-input-border Style de bordure du champ de saisie 1px solid var(--primary-400) common/base/discourse.scss
--d-input-bg-color--disabled Arrière-plan du champ de saisie désactivé var(--primary-very-low) common/base/discourse.scss
--d-input-text-color--disabled Couleur du texte du champ de saisie désactivé var(--primary-medium) common/base/discourse.scss
--d-input-border--disabled Bordure du champ de saisie désactivé 1px solid var(--primary-low) common/base/discourse.scss

Chat

Nom de la propriété Description Valeur par défaut Fichier source
--message-left-width Largeur gauche pour les messages 42px plugins/chat/assets/stylesheets/common/base-common.scss
--channel-list-avatar-size Taille des avatars dans la liste des canaux 30px plugins/chat/assets/stylesheets/common/base-common.scss
--chat-header-offset Décalage de l’en-tête pour le chat 45px plugins/chat/assets/stylesheets/common/base-common.scss
--chat-header-expanded-offset Décalage de l’en-tête étendu pour le chat 0px plugins/chat/assets/stylesheets/common/base-common.scss

Typographie

Nom de la propriété Description Valeur par défaut Fichier source
--d-font-family--monospace Pile de polices monospace ui-monospace, "Cascadia Mono", "Segoe UI Mono", "Liberation Mono", menlo, monaco, consolas, monospace common/foundation/base.scss
--heading-font-family Police de caractères pour les titres Référencé dans le code common/base/discourse.scss
--font-family Police de caractères de base Référencé dans le code common/base/discourse.scss
--line-height-small Hauteur de ligne petite Référencé dans le code common/base/_topic-list.scss
--line-height-medium Hauteur de ligne moyenne Référencé dans le code common/base/_topic-list.scss
--line-height-large Hauteur de ligne grande Référencé dans le code common/base/_topic-list.scss

Couleurs du thème

Nom de la propriété Description Valeur par défaut Fichier source
--primary Couleur principale #222222 color_definitions.scss
--secondary Couleur secondaire #ffffff color_definitions.scss
--tertiary Couleur tertiaire #0088cc color_definitions.scss
--quaternary Couleur quaternaire #e45735 color_definitions.scss
--header_background Couleur de fond de l’en-tête #ffffff color_definitions.scss
--header_primary Couleur principale de l’en-tête #222222 color_definitions.scss
--highlight Couleur de surbrillance #ffff4d color_definitions.scss
--danger Couleur danger/erreur #e45735 color_definitions.scss
--success Couleur succès #009900 color_definitions.scss
--love Couleur amour/cœur #fa6c8d color_definitions.scss
--d-selected Couleur de l’état sélectionné #e9e9e9 color_definitions.scss
--d-hover Couleur de l’état au survol #f2f2f2 color_definitions.scss

Valeurs de couleur RVB

Nom de la propriété Description Valeur par défaut Fichier source
--always-black-rgb Couleur noire en RVB 0, 0, 0 color_definitions.scss
--primary-rgb Couleur principale en RVB 34, 34, 34 color_definitions.scss
--primary-low-rgb Couleur principale faible en RVB 242, 242, 242 color_definitions.scss
--primary-very-low-rgb Couleur principale très faible en RVB 248, 248, 248 color_definitions.scss
--secondary-rgb Couleur secondaire en RVB 255, 255, 255 color_definitions.scss
--header_background-rgb Arrière-plan de l’en-tête en RVB 255, 255, 255 color_definitions.scss
--tertiary-rgb Couleur tertiaire en RVB 0, 136, 204 color_definitions.scss
--highlight-rgb Couleur de surbrillance en RVB 255, 255, 77 color_definitions.scss
--success-rgb Couleur succès en RVB 0, 153, 0 color_definitions.scss
12 « J'aime »

Ça a l’air super ! Je vois déjà quelques éléments que je pourrais utiliser dans mon propre thème.

2 « J'aime »

C’est vraiment génial et très utile. Merci !

:bière: :lunettes de soleil: :pouce levé: :étincelles:

2 « J'aime »