Ir para o conteúdo principal

Melhorar a Wiki

Siga este guia se quiser adicionar documentação na Wiki do Archcraft...

Pré-requisitos#

  • configurar o ambiente de desenvolvimento local, se você quer trabalhar localmente.
  • Você deve ter o entendimento básico da sintaxe de Markdown e MDX. Veja Docusaurus Markdown Features.
  • Você deve saber, pelo menos, como criar um fork, clonar um repositório e criar um pull request.

Arquivos e formato#

O diretório docs tem subdiretórios (para documentações de categorias) que contém os arquivos .md e .mdx para cada post wiki e um arquivo _category_.json para a categoria de documentos.

  • O arquivo _category_.json é usado para rotular e posicionar (na barra lateral) a categoria.
  • Aqui está o exemplo da seção Boot Archcraft do nosso wiki
docs    # Diretório principal└── boot-iso                        # Categoria do documento   ├── _category_.json              # Propriedades da categoria   ├── boot-with-usb.mdx            # Pagina da Wiki   └── boot-with-grub.mdx           # Outra página da Wiki na mesma categoria

Conteúdo inicial#

No Conteúdo inicial, você pode especificar a posição do doc na categoria, etc.

---sidebar_position: 1hide_table_of_contents: true---

Para mais informações, visite Docusaurus:Docs