docs/mkdocs.yml

160 lines
4.4 KiB
YAML
Raw Normal View History

2023-06-09 19:50:56 +00:00
site_name: InMo Docs
site_author: Ovsiannikov Aleksei
site_description: >-
Single documentation place for all Insanus Mokrassar libraries
site_url: https://docs.inmo.dev/
repo_name: InsanusMokrassar/docs
repo_url: https://github.com/InsanusMokrassar/docs
nav:
- Home: 'index.md'
2023-06-19 08:18:50 +00:00
- 'MicroUtils':
- 'micro_utils/index.md'
2023-06-09 19:50:56 +00:00
- 'Telegram Bot API':
2023-06-10 12:02:30 +00:00
- 'tgbotapi/index.md'
2023-06-13 16:45:37 +00:00
- KDocs: 'https://tgbotapi.inmo.dev'
2023-06-14 13:34:58 +00:00
- 'tgbotapi/faq.md'
2023-06-09 19:50:56 +00:00
- Introduction:
- 'tgbotapi/introduction/before-any-bot-project.md'
- 'tgbotapi/introduction/including-in-your-project.md'
- 'tgbotapi/introduction/proxy-setup.md'
- 'tgbotapi/introduction/first-bot.md'
2023-06-11 08:18:11 +00:00
- Guides:
- 'tgbotapi/guides/keyboards.md'
2023-06-09 19:50:56 +00:00
- Updates retrieving:
- 'tgbotapi/updates/updates-filters.md'
- 'tgbotapi/updates/long-polling.md'
- 'tgbotapi/updates/webhooks.md'
- 'tgbotapi/updates/heroku.md'
- Logic handling: 'tgbotapi/logic/'
- DSLs: 'tgbotapi/dsls/'
2023-10-06 15:26:09 +00:00
- PlaguBot (TBD):
- 'plagubot/'
2023-06-10 07:39:41 +00:00
- 'Krontab':
- 'krontab/index.md'
2023-06-13 16:45:37 +00:00
- KDocs: 'https://krontab.inmo.dev/'
2023-06-10 07:39:41 +00:00
- Introduction:
- 'krontab/introduction/including-in-project.md'
- 'krontab/introduction/how-to-use.md'
- 'krontab/introduction/faq.md'
- Describing:
- 'krontab/describing/string-format.md'
- 'krontab/describing/krontabscheduler.md'
2023-06-10 07:45:23 +00:00
- 'KSLog':
- 'kslog/index.md'
2023-06-13 16:45:37 +00:00
- KDocs: 'https://kslog.inmo.dev/'
2023-06-10 07:45:23 +00:00
- 'kslog/setup.md'
- 'kslog/logging.md'
2023-07-12 12:09:17 +00:00
- 'Navigation':
- 'navigation/index.md'
- 'navigation/getting-started.md'
2023-06-09 19:50:56 +00:00
use_directory_urls: false
theme:
name: material
2023-09-05 09:25:32 +00:00
logo: /resources/images/logo.png
favicon: /resources/images/favicon.png
2023-06-10 08:09:01 +00:00
palette:
- scheme: default
primary: teal
accent: cyan
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: blue grey
accent: light blue
toggle:
icon: material/brightness-4
name: Switch to light mode
2023-06-09 19:50:56 +00:00
hljs_languages:
- yaml
- kotlin
- javascript
- xml
- groovy
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
# - content.tabs.link
- content.tooltips
# - header.autohide
# - navigation.expand
- navigation.footer
- navigation.indexes
# - navigation.instant
# - navigation.prune
- navigation.sections
- navigation.tabs
# - navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
# - toc.integrate
font:
text: Roboto
code: Roboto Mono
# icon:
# annotation: material/arrow-right-circle
2023-06-09 19:50:56 +00:00
markdown_extensions:
- toc:
permalink: True
- smarty
- callouts
2023-06-10 07:52:58 +00:00
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
2023-06-10 10:13:55 +00:00
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:mermaid2.fence_mermaid
2023-07-22 16:30:54 +00:00
- admonition
- pymdownx.details
- attr_list
- md_in_html
2023-06-09 19:50:56 +00:00
plugins:
- search
- autorefs
- include_dir_to_nav
2023-07-21 13:55:27 +00:00
- mermaid2:
arguments:
theme: |
^(JSON.parse(__md_get("__palette").index == 1)) ? 'dark' : 'light'
2023-06-10 12:02:30 +00:00
2023-06-09 19:50:56 +00:00
# Customization
2023-06-10 10:13:55 +00:00
extra:
analytics:
provider: google
property: G-615VY8CQSM
social:
- icon: fontawesome/brands/github
link: https://github.com/InsanusMokrassar
- icon: fontawesome/brands/docker
link: https://hub.docker.com/r/insanusmokrassar
- icon: fontawesome/brands/telegram
link: https://t.me/InsanusMokrassar
- icon: fontawesome/brands/twitter
link: https://twitter.com/InsanusMokrassa
2023-06-09 19:50:56 +00:00
# annotate:
2023-06-10 12:02:30 +00:00
# json: [.s2]
2023-07-12 12:09:17 +00:00
extra_css:
2023-09-05 09:25:32 +00:00
- /resources/stylesheets/navigation.css
2023-07-12 12:09:17 +00:00
2023-09-05 09:25:32 +00:00
mermaid:
javascript:
- /resources/js/mermaid.min.js
- /resources/js/mermaid_dark_light_switcher.js