From 933d4811b7b9a095bf4cfcf692210dc33530ff5a Mon Sep 17 00:00:00 2001 From: Struchkov Mark Date: Sun, 19 Feb 2023 22:25:16 +0300 Subject: [PATCH] =?UTF-8?q?=D0=9D=D0=B0=D1=87=D0=B0=D0=BB=20=D0=BE=D1=84?= =?UTF-8?q?=D0=BE=D1=80=D0=BC=D0=BB=D0=B5=D0=BD=D0=B8=D0=B5=20=D0=B4=D0=BE?= =?UTF-8?q?=D0=BA=D1=83=D0=BC=D0=B5=D0=BD=D1=82=D0=B0=D1=86=D0=B8=D0=B8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- documentation/docs/architecture/concept.md | 0 .../docs/getting-started/configuration.md | 0 .../installing-dependencies.md | 122 ++++++++++++++++++ documentation/mkdocs.yml | 30 ++++- 4 files changed, 150 insertions(+), 2 deletions(-) create mode 100644 documentation/docs/architecture/concept.md create mode 100644 documentation/docs/getting-started/configuration.md create mode 100644 documentation/docs/getting-started/installing-dependencies.md diff --git a/documentation/docs/architecture/concept.md b/documentation/docs/architecture/concept.md new file mode 100644 index 0000000..e69de29 diff --git a/documentation/docs/getting-started/configuration.md b/documentation/docs/getting-started/configuration.md new file mode 100644 index 0000000..e69de29 diff --git a/documentation/docs/getting-started/installing-dependencies.md b/documentation/docs/getting-started/installing-dependencies.md new file mode 100644 index 0000000..d99d851 --- /dev/null +++ b/documentation/docs/getting-started/installing-dependencies.md @@ -0,0 +1,122 @@ +--- +hide: +- toc + +--- +# Варианты добавления в проект + +## Spring Boot Starter +Самый простой способ, если у вас небольшой монолитный Spring Boot проект. + +=== ":simple-apachemaven: Maven" + + ```xml + + dev.struchkov.godfather.telegram + telegram-bot-spring-boot-starter + 0.0.50-SNAPSHOT + + ``` + +=== ":simple-gradle: Gradle" + + ``` c++ + #include + + 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="Позволяет отправлять сообщения" + + ``` \ No newline at end of file diff --git a/documentation/mkdocs.yml b/documentation/mkdocs.yml index 758f120..68a4812 100644 --- a/documentation/mkdocs.yml +++ b/documentation/mkdocs.yml @@ -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 © 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