From f142b0a2a07e7a6e9deae3468f3b6f2b5a6c29fe Mon Sep 17 00:00:00 2001 From: Paul Jacobs Date: Thu, 17 Jun 2021 11:33:24 +0300 Subject: [PATCH] Formatting --- mkdocs-pdf.yml | 107 ++++++++++++++++++++------------------- mkdocs-percona.yml | 1 + mkdocs.yml | 123 +++++++++++++++++++++++---------------------- 3 files changed, 117 insertions(+), 114 deletions(-) diff --git a/mkdocs-pdf.yml b/mkdocs-pdf.yml index bd36856476..dd3b30333f 100644 --- a/mkdocs-pdf.yml +++ b/mkdocs-pdf.yml @@ -25,63 +25,64 @@ extra_javascript: - js/lightgallery.min.js markdown_extensions: - - attr_list - - toc: - permalink: True - - admonition - - def_list - - meta - - smarty: - smart_angled_quotes: true - - pymdownx.details - - pymdownx.mark - - pymdownx.smartsymbols - - pymdownx.tabbed - - pymdownx.tilde - - pymdownx.superfences: - custom_fences: - - name: mermaid - class: mermaid - format: !!python/name:mermaid2.fence_mermaid - - pymdownx.highlight: - linenums: false - - plantuml_markdown - - lightgallery + - attr_list + - toc: + permalink: True + - admonition + - def_list + - meta + - smarty: + smart_angled_quotes: true + - pymdownx.details + - pymdownx.mark + - pymdownx.smartsymbols + - pymdownx.tabbed + - pymdownx.tilde + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:mermaid2.fence_mermaid + - pymdownx.highlight: + linenums: false + - plantuml_markdown + - lightgallery plugins: - - search - - git-revision-date - - macros: - include_yaml: - - variables.yml - # https://pypi.org/project/mkdocs-exclude/ - - exclude: - glob: - - 'setting-up/client/docker.md' - # https://github.com/orzih/mkdocs-with-pdf - - with-pdf: - output_path: '_pdf/PerconaMonitoringAndManagement-2.18.0.pdf' - cover_title: 'Documentation' - cover_subtitle: 2.18.0 (June 1, 2021) - author: 'Percona Technical Documentation Team' - cover_logo: docs/_images/PMM_Logo.svg - debug_html: false - custom_template_path: _resources/templates - enabled_if_env: ENABLE_PDF_EXPORT - # Check links - but extends build time significantly - # https://pypi.org/project/mkdocs-htmlproofer-plugin/ - - htmlproofer + - search + - git-revision-date + - macros: + include_yaml: + - variables.yml + # https://pypi.org/project/mkdocs-exclude/ + - exclude: + glob: + - "setting-up/client/docker.md" + # https://github.com/orzih/mkdocs-with-pdf + - with-pdf: + output_path: "_pdf/PerconaMonitoringAndManagement-2.18.0.pdf" + cover_title: "Documentation" + cover_subtitle: 2.18.0 (June 1, 2021) + author: "Percona Technical Documentation Team" + cover_logo: docs/_images/PMM_Logo.svg + debug_html: false + custom_template_path: _resources/templates + enabled_if_env: ENABLE_PDF_EXPORT + # Check links - but extends build time significantly + # https://pypi.org/project/mkdocs-htmlproofer-plugin/ + - htmlproofer extra: # Used in main.html template and can't be externalised - open_issue_text: ' Report a problem - with this page' - open_issue_subject: 'PMM2: doc issue on page ' - open_issue_body: 'Please describe the issue here' - open_issue_tooltip: 'Report an issue with this page on GitHub' - edit_page_text: ' Edit this page' - updated_text: ' Page updated' - version: - provider: mike + open_issue_text: + ' Report a problem + with this page' + open_issue_subject: "PMM2: doc issue on page " + open_issue_body: "Please describe the issue here" + open_issue_tooltip: "Report an issue with this page on GitHub" + edit_page_text: ' Edit this page' + updated_text: ' Page updated' + version: + provider: mike nav: - Welcome: index.md diff --git a/mkdocs-percona.yml b/mkdocs-percona.yml index afb000ea62..c8be3cc6ee 100644 --- a/mkdocs-percona.yml +++ b/mkdocs-percona.yml @@ -28,6 +28,7 @@ extra_javascript: - https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js - js/table.number.js - js/tables.js + - https://unpkg.com/mermaid/dist/mermaid.min.js markdown_extensions: - attr_list diff --git a/mkdocs.yml b/mkdocs.yml index 2efa186297..a97cc3c42a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -10,20 +10,20 @@ repo_url: https://github.com/percona/pmm-doc edit_uri: edit/main/docs/ theme: - name: material - logo: _images/percona-logo.svg - favicon: _images/percona-favicon.ico - palette: - - media: "(prefers-color-scheme: light)" - scheme: percona-light - toggle: - icon: material/toggle-switch-off-outline - name: Switch to night mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - toggle: - icon: material/toggle-switch - name: Switch to day mode + name: material + logo: _images/percona-logo.svg + favicon: _images/percona-favicon.ico + palette: + - media: "(prefers-color-scheme: light)" + scheme: percona-light + toggle: + icon: material/toggle-switch-off-outline + name: Switch to night mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + toggle: + icon: material/toggle-switch + name: Switch to day mode extra_css: - https://unicons.iconscout.com/release/v3.0.3/css/line.css @@ -38,57 +38,58 @@ extra_javascript: - js/tables.js markdown_extensions: - - attr_list - - toc: - permalink: True - - admonition - - def_list - - meta - - smarty: - smart_angled_quotes: true - - pymdownx.details - - pymdownx.mark - - pymdownx.smartsymbols - - pymdownx.tabbed - - pymdownx.tilde - - pymdownx.superfences: - custom_fences: - - name: mermaid - class: mermaid - format: !!python/name:mermaid2.fence_mermaid - - pymdownx.highlight: - linenums: false - - plantuml_markdown - - lightgallery + - attr_list + - toc: + permalink: True + - admonition + - def_list + - meta + - smarty: + smart_angled_quotes: true + - pymdownx.details + - pymdownx.mark + - pymdownx.smartsymbols + - pymdownx.tabbed + - pymdownx.tilde + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:mermaid2.fence_mermaid + - pymdownx.highlight: + linenums: false + - plantuml_markdown + - lightgallery plugins: - - search - - git-revision-date - - macros: - include_yaml: - - variables.yml - # https://pypi.org/project/mkdocs-exclude/ - - exclude: - glob: - - 'setting-up/client/docker.md' - - mike: - version_selector: true - css_dir: css - javascript_dir: js - canonical_version: null - - section-index - - mermaid2 + - search + - git-revision-date + - macros: + include_yaml: + - variables.yml + # https://pypi.org/project/mkdocs-exclude/ + - exclude: + glob: + - "setting-up/client/docker.md" + - mike: + version_selector: true + css_dir: css + javascript_dir: js + canonical_version: null + - section-index + - mermaid2 extra: # Used in main.html template and can't be externalised - open_issue_text: ' Report a problem - with this page' - open_issue_subject: 'PMM2: doc issue on page ' - open_issue_body: 'Please describe the issue here' - open_issue_tooltip: 'Report an issue with this page on GitHub' - edit_page_text: ' Edit this page' - updated_text: ' Page updated' - version: - provider: mike + open_issue_text: + ' Report a problem + with this page' + open_issue_subject: "PMM2: doc issue on page " + open_issue_body: "Please describe the issue here" + open_issue_tooltip: "Report an issue with this page on GitHub" + edit_page_text: ' Edit this page' + updated_text: ' Page updated' + version: + provider: mike nav: - Welcome: index.md