Beagle v1.6 não é mais mantida ativamente. A versão documentada que você está visualizando pode conter funcionalidades depreciadas. Para obter as funcionalidades mais recentes, consulte a nossa última versão .
Muitas vezes, o markdown não é suficiente para expressar um bom conteúdo, como, por exemplo, adicionar um video para exemplificar um assunto ou posicionar uma imagem centralizada, sendo necessário adicionar código html para isso. Dada tal limitação, o framework “Hugo” nos oferece uma solução para não perdermos a experiência única usando markdown, abstraindo a necessidade de usar html e css. Essa solução se chama shortcode.
A melhor maneira para fazer referências a links internos a documentação é utilizando uma shortcode chamada “ref”, com ela, podemos passar um caminho absoluto até uma determinada página.
[Link Example]({{< ref path="/get-started/installing-beagle/backend.md" lang="pt" >}})
Para saber mais a respeito, acesse aqui
Os alertas são usados para destacar alguma informação importante ao seguir alguma etapa de configuração, tutorial, ou destacar requisitos necessários para alguma funcionalidade.
{{% alert color="info" %}}
## Alert example
- info - color - dark-blue
{{% /alert %}}
{{% alert color="success" %}}
## Alert example (2)
- sucess - color - green
{{% /alert %}}
{{% alert color="warning" %}}
## Alert example (2)
- warning - color - orange
{{% /alert %}}
{{% alert color="danger" %}}
## Alert example (2)
- danger - color - red
{{% /alert %}}
As imagens podem ser inseridas usando a sintaxe de markdown ![imageName](imageUrl)
. Entretanto, usar essa sintaxe limita algumas configurações de renderização, como por exemplo, a dimensão de tamanho da imagem (tamanho x largura).
Para renderizar imagens, gifs e demais tipos de figuras, podemos usar uma shortcode chamada figure
.
{{< figure src="https://media.glassdoor.com/sqll/2482761/zup-innovation-squarelogo-1583862820688.png" width="250" height="250 >}}
Para saber todos os parâmetro que o figure pode receber, acesse aqui
Você pode adicionar vídeos do youtube diretamente na documentação. Essa opção é ideal para complementar aquele conteúdo de tutorial ou divulgação. Para isso, use o ID do vídeo localizado em sua URL, ex:
nesse link: https://www.youtube.com/watch?v=ECNnZ6rP9qk
o ID encontra-se depois de v=
, ou seja, ECNnZ6rP9qk
{{< youtube ECNnZ6rP9qk >}}
As tabs são úteis para exemplificar códigos fonte que podem ser feitos em diferentes linguagens de programação ou alguma etapa de configuração obrigatória em diferentes plataformas, como, por exemplo, android, iOS, backend ou web.
{{< tabs id="MyUniqueTabID" >}}
{{% tab name="Tab1" %}}
{{% /tab %}}
{{% tab name="Tab2" %}}
{{% /tab %}}
{{% tab name="Tab3" %}}
{{% /tab %}}
{{< /tabs >}}
Se você quer se aprofundar mais sobre as shortcodes, recomendamos que acesse a documentação oficial do Hugo e saiba mais sobre como criar shortcodes customizadas.
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.