Skip to content

Latest commit

 

History

History
76 lines (53 loc) · 2.63 KB

README.md

File metadata and controls

76 lines (53 loc) · 2.63 KB

DICE ROLLING GAME DOCS

Sumário

Tecnologias da Documentação

  • DocFX: Utilizado para gerar as referências de API do projeto .NET em Markdown (md).
  • Docusaurus: Utilizado para construir o site estático a partir de arquivos Markdown, incluindo a API.

Estrutura da documentação

docs/
├── api/                    # Arquivos gerados pelo DocFX a partir do projeto C#
├── content/                # Conteúdo da documentação em Markdown
│ ├── api/                  # Arquivos do DocFX processados para funcionar no DocFX
│ ├── architecture/         # Arquivos relacionados à arquitetura do projeto
│ ├── game_design/          # Arquivos relacionados ao design do jogo
│ ├── tutorials/            # Tutoriais e guias da Framework
├── public/                 # Assets estáticos (imagens, vídeos, etc.)
│ ├── img/                  # Imagens
│ └── game_design/          # Arquivos relacionados ao design do jogo
└── src/                    # Projeto do Docusaurus
  ├── components/           # Componentes React
  ├── css/                  # Estilos CSS
  └── pages/                # Páginas do site

Documentação

Gerar a Documentação da API

Para gerar a documentação da API utilizando o DocFX, você precisará do projeto .NET em src/ e seguir os passos abaixo:

  1. Certifique-se de ter o DocFX instalado. Você pode instalar o DocFX globalmente usando o comando:

    dotnet tool install -g docfx

  2. Execute o comando abaixo para gerar a documentação da API:

    docfx

    A documentação será gerada na pasta docs/content/api.

Executar Scripts NPM

Para executar os scripts definidos no arquivo package.json:

  • Para processar os arquivos da API:

    npm --prefix docs run start

    O comando irá executar o código node processApiFiles.js, que trata os arquivos gerados pelo DocFX de acordo com processApiFiles.js

  • Para iniciar o servidor de desenvolvimento do Docusaurus:

    npm --prefix docs run start

Agora você está pronto para gerar a documentação da API e executar os scripts necessários para o desenvolvimento e manutenção da documentação do projeto.