Skip to content

Commit

Permalink
fix: conflict
Browse files Browse the repository at this point in the history
  • Loading branch information
axrobert committed Apr 10, 2024
2 parents 9780b75 + ed47814 commit b41159b
Show file tree
Hide file tree
Showing 18 changed files with 505 additions and 149 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
node_modules
.docusaurus/
build/
53 changes: 41 additions & 12 deletions docs/linguagens/python/estruturando-o-projeto.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,49 @@ displayed_sidebar: pythonSidebar
Agora precisamos criar uma estrutura para o projeto, definir onde vão ficar os eventos, os comandos e outras funções relacionadas ao bot.

### Estrutura de arquivos
![Estrutura do projeto](./assets/folder-structure.png)
<Directory>
<Directory.Folder name='cogs'>
<Directory.File name='commands.py' />
<Directory.File name='events.py' />
</Directory.Folder>

<Directory.File name='main.py' />

<Directory.Env />
</Directory>

### Descrição dos diretórios

<div className='flex flex-col gap-4'>
![Diretório main](./assets/dir-main.png)\
`main.py` será o arquivo principal, onde definimos o `client` e iniciamos o bot, além de que será usado para carregar outros arquivos do projeto.
<ul className='space-y-10 list-none p-0 [&>li]:space-y-1'>
<li>
<Directory>
<Directory.File name='main.py' highlight />
</Directory>

Será o arquivo principal, onde definimos o client e iniciamos o bot; Também será usado para carregar outros arquivos do projeto, como comandos e eventos.
</li>

<li>
<Directory>
<Directory.Folder name='cogs' highlight />
</Directory>

Cogs são extensões do discord.py. Cada cog é um módulo Python que contém um conjunto de comandos, listeners de eventos e/ou outras funcionalidades.
</li>

<li>
<Directory>
<Directory.Folder name='functions' highlight />
</Directory>

Pode conter arquivos com funções auxiliares indiretas, que serão usadas em um ou vários arquivos da aplicação.
</li>

![Diretório cogs](./assets/dir-cogs.png)\
Cogs são extensões do discord.py. Cada cog é um módulo Python que contém um conjunto de comandos, listeners de eventos e/ou outras funcionalidades.
<li>
<Directory>
<Directory.Env highlight />
</Directory>

![Diretório funções](./assets/dir-functions.png)\
A pasta `functions/` pode conter arquivos com funções auxiliares indiretas, que serão usadas em um ou vários arquivos da aplicação.

![Diretório env](./assets/dir-env.png)\
`.env` é usado para armazenar variáveis de ambiente de forma segura, como o token do bot e outras credenciais privadas.
</div>
Será usado para armazenar variáveis de ambiente de forma segura, como o token do bot e outras credenciais privadas.
</li>
</ul>
11 changes: 6 additions & 5 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import type * as Preset from '@docusaurus/preset-classic';
import type { Config } from '@docusaurus/types';
import { themes as prismThemes } from 'prism-react-renderer';
import { catppuccinLatteTheme, catppuccinMochaTheme } from './src/theme/prism-catppuccin';

const config: Config = {
title: 'TheGuideForYou',
Expand Down Expand Up @@ -65,15 +65,15 @@ const config: Config = {
label: 'Documentação',
},
{
href: 'https://github.com/facebook/docusaurus',
href: 'https://github.com/theguideforyou',
label: 'GitHub',
position: 'right',
},
],
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.oneDark,
theme: catppuccinLatteTheme,
darkTheme: catppuccinMochaTheme,
},
} satisfies Preset.ThemeConfig,
plugins: [
Expand All @@ -82,12 +82,13 @@ const config: Config = {
name: "docusaurus-tailwindcss",
configurePostCss(postcssOptions) {
// Appends TailwindCSS and AutoPrefixer.
postcssOptions.plugins.push(require("tailwindcss/nesting"));
postcssOptions.plugins.push(require("tailwindcss"));
postcssOptions.plugins.push(require("autoprefixer"));
return postcssOptions;
},
};
},
}
]
};

Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
"tailwindcss": "^3.4.0"
},
"devDependencies": {
"@catppuccin/tailwindcss": "^0.1.6",
"@docusaurus/module-type-aliases": "3.0.1",
"@docusaurus/tsconfig": "3.0.1",
"@docusaurus/types": "3.0.1",
Expand Down
Loading

0 comments on commit b41159b

Please sign in to comment.