ficheiro de configuração

O Qiandu lê a configuração de hugo.yaml no directório raiz do site Hugo. No ficheiro de configuração pode configurar todas as opções do seu site. Pode encontrar o ficheiro de configuração deste site em exampleSite/hugo.yaml para começar.

Barra de navegação

menu:
  main:
    - name: Documentation
      pageRef: /docs
      weight: 1
    - name: Blog
      pageRef: /blog
      weight: 2
    - name: About
      pageRef: /about
      weight: 3
    - name: Search
      weight: 4
      params:
        type: search
    - name: GitHub
      weight: 5
      url: ""
      params:
        icon: github

Existem vários tipos diferentes de itens de menu:

Link to a page in the site with pageRef
```
- name: Documentation
  pageRef: /docs
```

Link to an external URL with url

- name: GitHub
  url: "https://github.com"

Search bar with type: search

- name: Search
  params:
    type: search

Icon

- name: GitHub
  params:
    icon: github

Estes itens de menu podem ser classificados definindo weight.

Barra lateral

Barra lateral principal

A barra lateral principal é gerada automaticamente a partir da estrutura de directórios content. Para mais detalhes, aceda a Estrutura de diretórios.

Links adicionais

Links adicionais para a barra lateral são configurados na secção menu.sidebar do ficheiro de configuração:

hugo.yaml

menu:
  sidebar:
    - name: More
      params:
        type: separator
      weight: 1
    - name: "About"
      pageRef: "/about"
      weight: 2
    - name: "Docs ↗"
      url: "https://gohugo.io/name/"
      weight: 3

Barra lateral direita

Índice

O índice é gerado automaticamente com base nos títulos do ficheiro de conteúdo, isto pode ser desativado configurando toc:false em front matter.

content/docs/guide/configuration.md

---
title: Configuration
toc: false
---

Edite o link desta página

Para configurar o link de edição desta página, podemos definir params.editURL.base no ficheiro de configuração:

hugo.yaml

params:
  editURL:
    base: "https://github.com/your-username/your-repo/edit/main"

Os links de edição serão gerados automaticamente para cada página. Para definir um link de edição para uma página específica, pode definir editURL no front matter da página:

content/docs/guide/configuration.md

---
title: Configuration
editURL: "https://example.com/edit/this/page"
---

Footer

Declaração de direitos de autor

Para modificar o texto de copyright que aparece no rodapé do seu site, terá de criar um ficheiro chamado “i18n/en.yaml”. Neste ficheiro, preencha o novo texto de copyright, assim:

i18n/en.yaml

copyright: "© 2024 Qiandu.org"

Pode encontrar o ficheiro de exemplo i18n/en.yaml no repositório GitHub. Além disso, pode utilizar a formatação Markdown em texto protegido por direitos de autor.

outro

Favicon

Se precisar de personalizar o favicon, coloque o ficheiro do ícone na pasta static para substituir o [favicon padrão no tema](https://github. com/imfing/hextra/tree/main/static):

android-chrome-192x192.png
android-chrome-512x512.png
apple-touch-icon.png
favicon-16x16.png
favicon-32x32.png
favicon-dark.svg
favicon.ico
favicon.svg
site.webmanifest

Inclua os ficheiros favicon.ico e favicon.svg no seu projeto para garantir que o favicon do site é apresentado corretamente.

Embora o favicon.ico funcione geralmente em navegadores mais antigos, o favicon.svg é compatível com os navegadores modernos, pelo que uma abordagem mais moderna seria adicionar o favicon-dark.svg para servir melhor no modo escuro.

Sinta-se à vontade para utilizar ferramentas como favicon.io ou favycon para gerar estes ícones.

Configuração do tema de cores

Utilize a definição theme para configurar o modo de tema padrão e o botão de alternância que permite aos visitantes alternar entre o modo claro ou escuro.

hugo.yaml

params:
  theme:
    # light | dark | system
    default: system
    displayToggle: true

Opções para theme.default:

light - utilizar apenas o modo light
dark - utilize apenas o modo look
system - siga o sistema

theme.displayToggle controla a apresentação dos botões de alternância para alterar os temas. Quando definido como “true”, os visitantes podem alternar entre o modo claro ou escuro, substituindo a definição padrão.

Largura da página

A largura da página pode ser ajustada através do parâmetro params.page.width no ficheiro de configuração:

hugo.yaml

params:
  page:
    # full (100%), wide (90rem), normal (1280px)
    width: wide

Existem três opções: full, wide e normal.

Da mesma forma, a largura da barra de navegação e do footer também pode ser ajustada através de params.navbar.width e params.footer.width.

procurar

A pesquisa de texto integral fornecida pelo FlexSearch está ativada por defeito. Para personalizar o índice de pesquisa, defina params.search.flexsearch.index no ficheiro de configuração:

hugo.yaml

params:
  # Search
  search:
    enable: true
    type: flexsearch

    flexsearch:
      # index page by: content | summary | heading | title
      index: content

Opções para flexsearch.index:

content - pesquisa de conteúdo completo
summary - Overview Hugo Content Summary
heading - títulos de primeiro e segundo nível
title - pesquisa apenas pelo título

Para personalizar a tokenização de pesquisa, defina params.search.flexsearch.tokenize no ficheiro de configuração:

params:
    # ...
    flexsearch:
      # full | forward | reverse | strict 
      tokenize: forward

Opções flexsearch.tokenize:

strict - correspondência estrita de palavras
forward - correspondência de prefixo de palavra
reverse - correspondência do prefixo e sufixo da palavra
full - correspondência de substring de palavras.

Na lógica de segmentação de palavras padrão, uma frase em chinês é uma “palavra”

Para eliminar uma página do índice de pesquisa, altere excludeSearch: true no início:

content/docs/guide/configuration.md

---
title: Configuration
excludeSearch: true
---

Google Analytics

Para ativar o Google Analytics, defina services.googleAnalytics.ID:

hugo.yaml

services:
  googleAnalytics:
    ID: G-MEASUREMENT_ID

estrutura de diretórios Destaque de código