vadolasi/docs-incbm

Proposta de desenvolvimento para o incbm

Documentação INBCM

Este repositório contém a documentação oficial para o projeto INBCM (Inventário Nacional de Bens Culturais Musealizados), uma iniciativa destinada a facilitar o registro, envio e gestão de inventários culturais por instituições museológicas.

Estrutura do Repositório

• docs/: Contém a documentação em formato Markdown.
• mkdocs.yml: Arquivo de configuração para o MkDocs.
• docs/media/: Diretório para armazenar imagens relacionadas à documentação.

Como Visualizar a Documentação

Para visualizar a documentação localmente, siga as instruções abaixo:

Pré-requisitos

1. Certifique-se de ter o Python instalado.

Executando o Servidor Local

1. Clone este repositório para o seu ambiente local.

2. Navegue até o diretório do repositório:

   cd caminho/para/o/repo

3. Instale as dependências do projeto:

   pip install -r requirements.txt

4. Execute o seguinte comando para iniciar o servidor MkDocs local:

   mkdocs serve

5. Abra seu navegador e acesse http://localhost:8000/ para visualizar a documentação.

Contribuindo

Se você deseja contribuir para a documentação do INBCM, sinta-se à vontade para enviar pull requests. Certifique-se de seguir as diretrizes de contribuição do projeto.

Obrigado por contribuir para o desenvolvimento e aprimoramento do INBCM!