Начал оформление документации
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
Struchkov Mark 2023-02-19 22:25:16 +03:00
parent d54091054d
commit 933d4811b7
Signed by: upagge
GPG Key ID: D3018BE7BA428CA6
4 changed files with 150 additions and 2 deletions

View File

@ -0,0 +1,122 @@
---
hide:
- toc
---
# Варианты добавления в проект
## Spring Boot Starter
Самый простой способ, если у вас небольшой монолитный Spring Boot проект.
=== ":simple-apachemaven: Maven"
```xml
<dependency>
<groupId>dev.struchkov.godfather.telegram</groupId>
<artifactId>telegram-bot-spring-boot-starter</artifactId>
<version>0.0.50-SNAPSHOT</version>
</dependency>
```
=== ":simple-gradle: Gradle"
``` c++
#include <iostream>
int main(void) {
std::cout << "Hello world!" << std::endl;
return 0;
}
```
## Quarkus Extension
На данный момент раздел находится в разработке.
=== ":simple-apachemaven: Maven"
```
```
=== ":simple-gradle: Gradle"
```
```
### Reactive
На данный момент раздел находится в разработке.
## Основные зависимости проекта
Вы можете добавить основные зависимости в свой проект и сконфигурировать его более тонко под ваши нужды. Однако для этого потребуется хорошее знание архитектуры проекта.
Этот вариант подойдет вам, если у вас используется микросервисная архитектура. Так как логично разделить стадии получения, обработки и отправки сообщений на разные сервисы.
Также этот вариант подойдет вам, если вы используете менее популярный фреймворк, так как основные зависимости написаны без привязки к какому-то конкретному фреймворку.
Всего основных зависимостей три:
=== ":simple-spring: Spring"
Эти зависимости подойдут вам, если вы используете SpringBoot 3.0.0+
=== ":simple-apachemaven: Maven"
``` xml title="Позволяет получать сообщения"
```
``` xml title="Содержит всю логику работы"
```
``` xml title="Позволяет отправлять сообщения"
```
=== ":simple-gradle: Gradle"
``` xml title="Позволяет получать сообщения"
```
``` xml title="Содержит всю логику работы"
```
``` xml title="Позволяет отправлять сообщения"
```
=== ":simple-quarkus: Quarkus"
Эти зависимости подойдут вам, если вы используете Quarkus 2.16.0+
=== ":simple-apachemaven: Maven"
``` xml title="Позволяет получать сообщения"
```
``` xml title="Содержит всю логику работы"
```
``` xml title="Позволяет отправлять сообщения"
```
=== ":simple-gradle: Gradle"
``` xml title="Позволяет получать сообщения"
```
``` xml title="Содержит всю логику работы"
```
``` xml title="Позволяет отправлять сообщения"
```

View File

@ -2,10 +2,19 @@ site_name: GodFather Telegram
repo_url: https://github.com/Godfather-Bots/telegram-bot
repo_name: Godfather-Bots/telegram-bot
copyright: Copyright &copy; 2018 - 2023 Struchkov Mark
#edit_uri: edit/master/documentation/docs
nav:
- 'index.md'
- 'Быстрый старт':
- 'getting-started/installing-dependencies.md'
- 'getting-started/configuration.md'
# - 'Гайды':
- 'Архитектура':
- 'architecture/concept.md'
# - 'ChangeLog':
theme:
name: material
@ -33,17 +42,17 @@ theme:
- navigation.tracking
- navigation.tabs
- navigation.tabs.sticky
- navigation.footer
- search
- search.suggest
- search.highlight
- content.action.edit
- content.code.copy
- toc.follow
plugins:
- meta
- tags
- social
- blog:
blog_dir: ./blog
- search:
lang: ru
- git-revision-date-localized:
@ -53,6 +62,23 @@ markdown_extensions:
permalink: true
toc_depth: 3
title: Содержание
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.snippets
- pymdownx.inlinehilite
- pymdownx.details
- pymdownx.smartsymbols
- pymdownx.betterem
- pymdownx.tabbed:
alternate_style: true
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
extra:
generator: false