Documentando propriedades personalizadas

Recentemente fiz isso para um tema, solicitando ao Claude-3.5, incorporado ao Cursor, que gerasse documentação. Funcionou muito bem, então quis tentar para a base de código principal do Discourse.

Restringí o contexto a arquivos .scss, mas me deparei com limites de contexto e o modelo continua hesitando em incluir todas as propriedades. Então, queria compartilhar, talvez alguém tenha um prompt ou abordagem melhor?

@Codebase Gere uma tabela completa de TODAS as propriedades CSS personalizadas da base de código do Discourse. Inclua todas as propriedades de todos os arquivos e organize-as nas seguintes categorias: Layout e Dimensões, Raio da Borda, Navegação, Barra Lateral, Controles de Entrada, Chat, Tipografia, Cores do Tema, Valores de Cor RGB. Para cada propriedade, mostre seu nome, descrição, valor padrão e arquivo de origem. Formate os nomes das propriedades e os valores padrão com backticks de código. Não omita nenhuma propriedade, não faça perguntas e não adicione comentários.

Layout e Dimensões

Nome da Propriedade Descrição Valor Padrão Arquivo de Origem
--d-max-width Largura máxima do conteúdo 1110px desktop/discourse.scss
--topic-body-width Largura do conteúdo do corpo do tópico 750px common/foundation/base.scss
--topic-body-width-padding Preenchimento do corpo do tópico 20px common/foundation/base.scss
--topic-avatar-width Largura do avatar nos tópicos 45px common/foundation/base.scss
--d-wrap-padding-h Preenchimento horizontal para o contêiner de envolvimento 0.67em common/base/discourse.scss

Raio da Borda

Nome da Propriedade Descrição Valor Padrão Arquivo de Origem
--d-border-radius Raio da borda padrão 2px common/foundation/base.scss
--d-border-radius-large Raio da borda grande 2px common/foundation/base.scss
--d-nav-pill-border-radius Raio da borda para pílulas de navegação 2px common/foundation/base.scss
--d-button-border-radius Raio da borda para botões 2px common/foundation/base.scss
--d-input-border-radius Raio da borda para entradas 2px common/foundation/base.scss
--full-page-border-radius Raio da borda para página inteira 12px plugins/chat/assets/stylesheets/common/base-common.scss

Navegação

Nome da Propriedade Descrição Valor Padrão Arquivo de Origem
--d-nav-color Cor do texto da navegação var(--primary) common/base/discourse.scss
--d-nav-bg-color Fundo da navegação transparent common/base/discourse.scss
--d-nav-color--hover Cor do texto da navegação ao passar o mouse var(--primary) common/base/discourse.scss
--d-nav-bg-color--hover Fundo da navegação ao passar o mouse var(--d-hover) common/base/discourse.scss
--d-nav-color--active Cor do texto da navegação ativa var(--tertiary) common/base/discourse.scss
--d-nav-bg-color--active Fundo da navegação ativa transparent common/base/discourse.scss
--d-nav-border-color--active Borda da navegação ativa var(--d-nav-color--active) common/base/discourse.scss
--d-nav-underline-height Altura do sublinhado da navegação 0.125em common/base/discourse.scss

Barra Lateral

Nome da Propriedade Descrição Valor Padrão Arquivo de Origem
--d-sidebar-width Largura da barra lateral 17em common/base/sidebar.scss
--d-sidebar-row-horizontal-padding Preenchimento horizontal para linhas 1rem common/base/sidebar.scss
--d-sidebar-row-height Altura das linhas da barra lateral 2.2em common/base/sidebar.scss
--d-sidebar-animation-time Duração da animação 0.25s common/base/sidebar.scss
--d-sidebar-animation-ease Suavização da animação ease-in-out common/base/sidebar.scss
--d-sidebar-background Cor de fundo var(--secondary) common/base/sidebar.scss
--d-sidebar-admin-background Fundo da seção de administração var(--primary-very-low) common/base/sidebar.scss
--d-sidebar-footer-fade Cor de desvanecimento do rodapé rgba(var(--secondary-rgb), 1) common/base/sidebar.scss
--d-sidebar-header-color Cor do texto do cabeçalho var(--primary-medium) common/base/sidebar.scss
--d-sidebar-header-icon-color Cor do ícone do cabeçalho var(--primary-medium) common/base/sidebar.scss
--d-sidebar-border-color Cor da borda var(--primary-low) common/base/sidebar.scss
--d-sidebar-link-color Cor do texto do link var(--primary-high) common/base/sidebar.scss
--d-sidebar-link-icon-color Cor do ícone do link var(--primary-500) common/base/sidebar.scss
--d-sidebar-link-badge-color Cor do distintivo do link var(--primary-700) common/base/sidebar.scss
--d-sidebar-prefix-background Cor de fundo do prefixo var(--primary-low) common/base/sidebar.scss
--d-sidebar-prefix-color Cor do texto do prefixo var(--d-sidebar-link-color) common/base/sidebar.scss
--d-sidebar-suffix-color Cor do sufixo var(--tertiary-med-or-tertiary) common/base/sidebar.scss

Controles de Entrada

Nome da Propriedade Descrição Valor Padrão Arquivo de Origem
--d-input-bg-color Cor de fundo da entrada var(--secondary) common/base/discourse.scss
--d-input-text-color Cor do texto da entrada var(--primary) common/base/discourse.scss
--d-input-border Estilo da borda da entrada 1px solid var(--primary-400) common/base/discourse.scss
--d-input-bg-color--disabled Fundo da entrada desativada var(--primary-very-low) common/base/discourse.scss
--d-input-text-color--disabled Cor do texto da entrada desativada var(--primary-medium) common/base/discourse.scss
--d-input-border--disabled Borda da entrada desativada 1px solid var(--primary-low) common/base/discourse.scss

Chat

Nome da Propriedade Descrição Valor Padrão Arquivo de Origem
--message-left-width Largura esquerda para mensagens 42px plugins/chat/assets/stylesheets/common/base-common.scss
--channel-list-avatar-size Tamanho dos avatares na lista de canais 30px plugins/chat/assets/stylesheets/common/base-common.scss
--chat-header-offset Deslocamento do cabeçalho para o chat 45px plugins/chat/assets/stylesheets/common/base-common.scss
--chat-header-expanded-offset Deslocamento do cabeçalho expandido para o chat 0px plugins/chat/assets/stylesheets/common/base-common.scss

Tipografia

Nome da Propriedade Descrição Valor Padrão Arquivo de Origem
--d-font-family--monospace Pilha de fontes monoespaçadas ui-monospace, "Cascadia Mono", "Segoe UI Mono", "Liberation Mono", menlo, monaco, consolas, monospace common/foundation/base.scss
--heading-font-family Família de fontes para títulos Referenciado no código common/base/discourse.scss
--font-family Família de fontes base Referenciado no código common/base/discourse.scss
--line-height-small Altura da linha pequena Referenciado no código common/base/_topic-list.scss
--line-height-medium Altura da linha média Referenciado no código common/base/_topic-list.scss
--line-height-large Altura da linha grande Referenciado no código common/base/_topic-list.scss

Cores do Tema

Nome da Propriedade Descrição Valor Padrão Arquivo de Origem
--primary Cor primária #222222 color_definitions.scss
--secondary Cor secundária #ffffff color_definitions.scss
--tertiary Cor terciária #0088cc color_definitions.scss
--quaternary Cor quaternária #e45735 color_definitions.scss
--header_background Cor de fundo do cabeçalho #ffffff color_definitions.scss
--header_primary Cor primária do cabeçalho #222222 color_definitions.scss
--highlight Cor de destaque #ffff4d color_definitions.scss
--danger Cor de perigo/erro #e45735 color_definitions.scss
--success Cor de sucesso #009900 color_definitions.scss
--love Cor de amor/coração #fa6c8d color_definitions.scss
--d-selected Cor do estado selecionado #e9e9e9 color_definitions.scss
--d-hover Cor do estado ao passar o mouse #f2f2f2 color_definitions.scss

Valores de Cor RGB

Nome da Propriedade Descrição Valor Padrão Arquivo de Origem
--always-black-rgb Cor preta em RGB 0, 0, 0 color_definitions.scss
--primary-rgb Cor primária em RGB 34, 34, 34 color_definitions.scss
--primary-low-rgb Cor primária baixa em RGB 242, 242, 242 color_definitions.scss
--primary-very-low-rgb Cor primária muito baixa em RGB 248, 248, 248 color_definitions.scss
--secondary-rgb Cor secundária em RGB 255, 255, 255 color_definitions.scss
--header_background-rgb Fundo do cabeçalho em RGB 255, 255, 255 color_definitions.scss
--tertiary-rgb Cor terciária em RGB 0, 136, 204 color_definitions.scss
--highlight-rgb Cor de destaque em RGB 255, 255, 77 color_definitions.scss
--success-rgb Cor de sucesso em RGB 0, 153, 0 color_definitions.scss
12 curtidas

Parece ótimo! Já consigo ver algumas coisas que posso usar no meu próprio tema.

2 curtidas

Isso é muito incrível e muito útil. Obrigado!

:beers: :sunglasses: :+1: :sparkles:

2 curtidas