twbs/bootstrap

Reusable Sass utilities API documentation section

Open

#38.434 aberto em 10 de abr. de 2023

Ver no GitHub
 (3 comments) (0 reactions) (0 assignees)MDX (78.904 forks)batch import
docsenhancementhelp wanted

Métricas do repositório

Stars
 (174.240 stars)
Métricas de merge de PR
 (Mesclagem média 4d 15h) (99 fundiu PRs em 30d)

Description

Enhancement suggested in https://github.com/twbs/bootstrap/pull/38219#discussion_r1148250058.

Our "Sass utilities API" sections are always written the same way.

We would need a shortcode or partial or anything else with two params:

  • First part of the sentence (e.g. "Background" or "Object fit")
  • The param (the key) used for scss-docs (e.g. "utils-bg-color")

We would like to call it like this:

{{< sass-utilities-api-section "Background" "utils-bg-color" >}}

And it would contain something like:

### Sass utilities API

{{ firstParam }} utilities are declared in our utilities API in `scss/_utilities.scss`. [Learn how to use the utilities API.]({{< docsref "/utilities/api#using-the-api" >}})

{{< scss-docs name="{{ secondParam }}" file="scss/_utilities.scss" >}}

We would need some help to do it. On my side, I don't exactly how to build it with Hugo. I tried a few things but haven't managed to succeed by calling scss-docs and docsref within another shortcode or from a partial.

Guia do colaborador

Direção de pesquisa
Estude a documentação de shortcodes e parciais do Hugo. Crie um novo shortcode que aceita dois parâmetros e gere o HTML desejado. Certifique se de que pode chamar `scss docs` e `docsref` de dentro do shortcode usando as funções `{{ partial }}` e `{{ .Get }}` do Hugo. Teste adicionando o a uma página de documentação.
Pilha de tecnologia
javascriptcsshtml
Domain
documentationfrontend
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitHugo
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65