Рефакторинг документации
This commit is contained in:
parent
50feffd2c7
commit
0508604290
83
.drone.yml
83
.drone.yml
@ -97,45 +97,54 @@ steps:
|
|||||||
- gpg --pinentry-mode loopback --passphrase $GPG_PASSPHRASE --import gpg.key
|
- gpg --pinentry-mode loopback --passphrase $GPG_PASSPHRASE --import gpg.key
|
||||||
- mvn --settings maven-settings.xml -U -P ossrh,release-struchkov-nexus clean deploy
|
- mvn --settings maven-settings.xml -U -P ossrh,release-struchkov-nexus clean deploy
|
||||||
|
|
||||||
#---
|
---
|
||||||
#kind: pipeline
|
kind: pipeline
|
||||||
#type: docker
|
type: docker
|
||||||
#name: create-docs-site
|
name: create-develop-docs-site
|
||||||
#
|
|
||||||
#trigger:
|
|
||||||
# branch:
|
|
||||||
# - docs
|
|
||||||
# - master
|
|
||||||
#
|
|
||||||
#steps:
|
|
||||||
# - name: build site
|
|
||||||
# image: upagge/mkdocs-material
|
|
||||||
# environment:
|
|
||||||
# SSH_DEPLOY_KEY:
|
|
||||||
# from_secret: SSH_DEPLOY_KEY
|
|
||||||
# SSH_DEPLOY_HOST:
|
|
||||||
# from_secret: SSH_DEPLOY_HOST
|
|
||||||
# SSH_DEPLOY_PORT:
|
|
||||||
# from_secret: SSH_DEPLOY_PORT
|
|
||||||
# SSH_DEPLOY_PATH:
|
|
||||||
# from_secret: SSH_DEPLOY_PATH
|
|
||||||
# SSH_DEPLOY_USER:
|
|
||||||
# from_secret: SSH_DEPLOY_USER
|
|
||||||
# commands:
|
|
||||||
# - eval $(ssh-agent -s)
|
|
||||||
# - mkdir -p ~/.ssh
|
|
||||||
# - echo "$SSH_DEPLOY_KEY" >> ~/.ssh/id_rsa
|
|
||||||
# - chmod 700 ~/.ssh
|
|
||||||
# - chmod 600 ~/.ssh/id_rsa
|
|
||||||
# - ssh-keyscan -p $SSH_DEPLOY_PORT $SSH_DEPLOY_HOST >> ~/.ssh/known_hosts
|
|
||||||
# - chmod 644 ~/.ssh/known_hosts
|
|
||||||
# - cd documentation
|
|
||||||
# - mkdocs build
|
|
||||||
# - mv site godfather-telegram
|
|
||||||
# - scp -r -P $SSH_DEPLOY_PORT ./godfather-telegram $SSH_DEPLOY_USER@$SSH_DEPLOY_HOST:$SSH_DEPLOY_PATH
|
|
||||||
|
|
||||||
|
trigger:
|
||||||
|
branch:
|
||||||
|
- develop
|
||||||
|
- docs
|
||||||
|
|
||||||
|
clone:
|
||||||
|
disable: true
|
||||||
|
|
||||||
|
steps:
|
||||||
|
|
||||||
|
- name: build docs
|
||||||
|
image: git.struchkov.dev/upagge/mkdocs-material-insiders:latest
|
||||||
|
volumes:
|
||||||
|
- name: mkdocs_cache
|
||||||
|
path: ${DRONE_WORKSPACE}/documentation/ru/.cache
|
||||||
|
environment:
|
||||||
|
GIT_SSH:
|
||||||
|
from_secret: GIT_SSH
|
||||||
|
GIT_SSH_COMMAND: "ssh -i ~/.ssh/id_rsa -p 222"
|
||||||
|
commands:
|
||||||
|
- eval $(ssh-agent -s)
|
||||||
|
- mkdir -p ~/.ssh
|
||||||
|
- chmod 700 ~/.ssh
|
||||||
|
- echo "$GIT_SSH" >> ~/.ssh/id_rsa
|
||||||
|
- chmod 600 ~/.ssh/id_rsa
|
||||||
|
- ssh-keyscan -p 222 git.struchkov.dev >> ~/.ssh/known_hosts
|
||||||
|
- chmod 644 ~/.ssh/known_hosts
|
||||||
|
- git config --global user.name "${DRONE_COMMIT_AUTHOR_NAME}"
|
||||||
|
- git config --global user.email "${DRONE_COMMIT_AUTHOR_EMAIL}"
|
||||||
|
- git clone ssh://git@git.struchkov.dev:222/Telegram-Bots/gitlab-notification.git .
|
||||||
|
- git checkout $DRONE_COMMIT
|
||||||
|
- cd documentation/ru
|
||||||
|
- mike deploy --prefix gitlab-notification/ru --branch docs-deploy --push --update-aliases develop
|
||||||
|
|
||||||
|
image_pull_secrets:
|
||||||
|
- DOCKER_AUTH
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
- name: mkdocs_cache
|
||||||
|
host:
|
||||||
|
path: /drone/volume/mkdocs_cache/gitlab_notification/ru
|
||||||
---
|
---
|
||||||
kind: signature
|
kind: signature
|
||||||
hmac: bdeec02d3273fc1640c972d68cc52bffa2319ea53470d0c273f42125a1dec127
|
hmac: 07fb69338d4ebdd3bc98cbef5bcd99e5be057f783e6c92844f3fe556d411267b
|
||||||
|
|
||||||
...
|
...
|
||||||
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
77
documentation/ru/docs/stylesheets/extra.css
Normal file
77
documentation/ru/docs/stylesheets/extra.css
Normal file
@ -0,0 +1,77 @@
|
|||||||
|
.md-typeset .admonition, .md-typeset details {
|
||||||
|
font-size: 0.75rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.md-typeset h1, .md-typeset h2 {
|
||||||
|
font-weight: 500;
|
||||||
|
}
|
||||||
|
|
||||||
|
.md-typeset h2 {
|
||||||
|
margin-top: 4rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.md-typeset h3 {
|
||||||
|
margin-top: 2.2rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.md-typeset mark {
|
||||||
|
background-color: #fff3bc;
|
||||||
|
margin: -4px -4px -6px;
|
||||||
|
padding: 4px 4px 6px;
|
||||||
|
}
|
||||||
|
|
||||||
|
@keyframes heart {
|
||||||
|
0%, 40%, 80%, 100% {
|
||||||
|
transform: scale(1);
|
||||||
|
}
|
||||||
|
20%, 60% {
|
||||||
|
transform: scale(1.15);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.heart {
|
||||||
|
animation: heart 1000ms infinite;
|
||||||
|
}
|
||||||
|
|
||||||
|
@keyframes ninja-disappear {
|
||||||
|
0% {
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
50% {
|
||||||
|
opacity: 0.3;
|
||||||
|
}
|
||||||
|
100% {
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.ninja-disappear {
|
||||||
|
animation: ninja-disappear 3000ms infinite;
|
||||||
|
animation-delay: 1500ms;
|
||||||
|
}
|
||||||
|
|
||||||
|
@keyframes jingle-bell-swing {
|
||||||
|
0% {
|
||||||
|
transform: rotate(0deg);
|
||||||
|
}
|
||||||
|
50% {
|
||||||
|
transform: rotate(10deg);
|
||||||
|
}
|
||||||
|
100% {
|
||||||
|
transform: rotate(0deg);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.jingle-bell {
|
||||||
|
animation: jingle-bell-swing 2s ease-in-out infinite;
|
||||||
|
transform-origin: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@media(min-width: 768px) {
|
||||||
|
.frontpage-grid {
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: repeat(2, 1fr);
|
||||||
|
column-gap: 2em;
|
||||||
|
row-gap: 1em;
|
||||||
|
}
|
||||||
|
}
|
@ -1,5 +1,5 @@
|
|||||||
site_name: GodFather Telegram
|
site_name: GodFather Telegram
|
||||||
site_url: https://docs.struchkov.dev/godfather-telegram/
|
site_url: https://docs.struchkov.dev/godfather-telegram/ru
|
||||||
|
|
||||||
repo_url: https://github.com/Godfather-Bots/telegram-bot
|
repo_url: https://github.com/Godfather-Bots/telegram-bot
|
||||||
repo_name: Godfather-Bots/telegram-bot
|
repo_name: Godfather-Bots/telegram-bot
|
||||||
@ -26,62 +26,92 @@ theme:
|
|||||||
logo: simple/telegram
|
logo: simple/telegram
|
||||||
repo: fontawesome/brands/github
|
repo: fontawesome/brands/github
|
||||||
palette:
|
palette:
|
||||||
- scheme: default
|
- media: "(prefers-color-scheme)"
|
||||||
|
primary: light blue
|
||||||
|
accent: indigo
|
||||||
|
scheme: default
|
||||||
|
toggle:
|
||||||
|
icon: material/brightness-auto
|
||||||
|
name: Switch to light mode
|
||||||
|
- media: "(prefers-color-scheme: light)"
|
||||||
primary: light blue
|
primary: light blue
|
||||||
accent: indigo
|
accent: indigo
|
||||||
toggle:
|
toggle:
|
||||||
icon: material/brightness-7
|
icon: material/brightness-7
|
||||||
name: Switch to dark mode
|
name: Switch to dark mode
|
||||||
- scheme: slate
|
- media: "(prefers-color-scheme: dark)"
|
||||||
|
scheme: slate
|
||||||
toggle:
|
toggle:
|
||||||
icon: material/brightness-4
|
icon: material/brightness-4
|
||||||
name: Switch to light mode
|
name: Switch to system preference
|
||||||
|
|
||||||
features:
|
features:
|
||||||
- navigation.instant
|
- navigation.instant
|
||||||
- navigation.indexes
|
- navigation.indexes
|
||||||
- navigation.sections
|
- navigation.sections
|
||||||
- navigation.tracking
|
- navigation.tracking
|
||||||
- navigation.tabs
|
|
||||||
- navigation.tabs.sticky
|
|
||||||
- navigation.footer
|
- navigation.footer
|
||||||
|
- navigation.prune
|
||||||
- search
|
- search
|
||||||
- search.suggest
|
- search.suggest
|
||||||
- search.highlight
|
- search.highlight
|
||||||
- content.action.edit
|
- content.action.edit
|
||||||
- content.code.copy
|
- content.code.copy
|
||||||
|
- content.code.annotate
|
||||||
|
- content.tooltips
|
||||||
- toc.follow
|
- toc.follow
|
||||||
plugins:
|
- toc.integrate
|
||||||
- social
|
plugins:
|
||||||
- meta
|
- social
|
||||||
- tags
|
- typeset
|
||||||
- search:
|
# - blog:
|
||||||
lang: ru
|
# blog_toc: true
|
||||||
- git-revision-date-localized:
|
# post_date_format: short
|
||||||
enable_creation_date: true
|
# post_url_format: "{slug}"
|
||||||
|
# archive_toc: true
|
||||||
|
# categories: false
|
||||||
|
# authors: false
|
||||||
|
# - optimize:
|
||||||
|
# optimize_jpg_quality: 90
|
||||||
|
- tags
|
||||||
|
- search:
|
||||||
|
lang: ru
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
- toc:
|
- pymdownx.details
|
||||||
permalink: true
|
- pymdownx.superfences
|
||||||
toc_depth: 3
|
- pymdownx.inlinehilite
|
||||||
title: Содержание
|
- pymdownx.snippets:
|
||||||
|
auto_append:
|
||||||
|
- includes/abbreviations.md
|
||||||
|
- pymdownx.critic
|
||||||
|
- pymdownx.caret
|
||||||
|
- pymdownx.keys
|
||||||
|
- pymdownx.mark
|
||||||
|
- pymdownx.tilde
|
||||||
|
- attr_list
|
||||||
|
- def_list
|
||||||
|
- pymdownx.tasklist:
|
||||||
|
custom_checkbox: true
|
||||||
- pymdownx.highlight:
|
- pymdownx.highlight:
|
||||||
anchor_linenums: true
|
anchor_linenums: true
|
||||||
- pymdownx.superfences:
|
line_spans: __span
|
||||||
custom_fences:
|
pygments_lang_class: true
|
||||||
- name: mermaid
|
|
||||||
class: mermaid
|
|
||||||
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
||||||
- pymdownx.snippets
|
|
||||||
- pymdownx.inlinehilite
|
|
||||||
- pymdownx.details
|
|
||||||
- pymdownx.smartsymbols
|
|
||||||
- pymdownx.betterem
|
|
||||||
- pymdownx.tabbed:
|
- pymdownx.tabbed:
|
||||||
alternate_style: true
|
alternate_style: true
|
||||||
- pymdownx.emoji:
|
- pymdownx.emoji:
|
||||||
emoji_index: !!python/name:materialx.emoji.twemoji
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
||||||
emoji_generator: !!python/name:materialx.emoji.to_svg
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||||
|
- admonition
|
||||||
|
- abbr
|
||||||
|
- md_in_html
|
||||||
|
- footnotes
|
||||||
|
- toc:
|
||||||
|
toc_depth: 3
|
||||||
|
title: Содержание
|
||||||
|
permalink: ⚓︎
|
||||||
|
|
||||||
|
extra_css:
|
||||||
|
- stylesheets/extra.css
|
||||||
extra:
|
extra:
|
||||||
generator: false
|
generator: false
|
||||||
analytics:
|
analytics:
|
Loading…
Reference in New Issue
Block a user