diff --git a/.github/workflows/documentation_deploy.yml b/.github/workflows/documentation_deploy.yml new file mode 100644 index 0000000..82a0c84 --- /dev/null +++ b/.github/workflows/documentation_deploy.yml @@ -0,0 +1,16 @@ +name: build +on: + push: + branches: + - main +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-python@v2 + with: + python-version: 3.x + - run: pip install mkdocs + - run: pip install mkdocs-material + - run: mkdocs gh-deploy --force --clean --verbose diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..6dff0a4 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,13 @@ +# Documentação do Bot Discord + +Bem-vindo à documentação oficial do nosso Bot Discord desenvolvido em Python! Este projeto oferece diversas funcionalidades para aprimorar a experiência do usuário nos servidores do Discord. O bot foi criado com o objetivo de ser flexível, amigável e expansível, permitindo a personalização de comandos e integração com outros serviços. + +## Funcionalidades Principais + +### 1. Comandos Personalizados + +O bot suporta uma variedade de comandos personalizáveis para atender às necessidades específicas do seu servidor. Você pode configurar novos comandos ou personalizar os existentes de acordo com suas preferências. + +### 2. Integração com Outros Serviços + +Além das funcionalidades nativas, nosso bot é projetado para integrar-se facilmente a outros serviços. Isso proporciona uma experiência mais completa e personalizada para os usuários do seu servidor. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..6e69c25 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,19 @@ +site_name: Discord Bot +repo_url: https://github.com/Robso-creator/discord_bot + +exclude_docs: + README* + +theme: + name: material + palette: + - scheme: default + primary: purple + toggle: + icon: material/weather-night + name: Modo noturno + - scheme: slate + primary: deep purple + toggle: + icon: material/weather-sunny + name: Modo claro diff --git a/requirements.txt b/requirements.txt index 67870b8..ac82f78 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,6 @@ colorlog==6.8.2 discord==2.3.2 loadotenv==1.0.1 +mkdocs==1.5.3 +mkdocs-material==9.5.6 pre-commit==3.6.0