Skip to content

Commit 2d403ec

Browse files
author
Alina Derkach
committed
PS 8375 Add .yml files and configure the project
new file: docs/_resource/overrides/404.html new file: docs/_resource/overrides/main.html new file: docs/_resource/overrides/partials/header.html new file: docs/_resource/overrides/partials/nav.html new file: docs/_resource/templates/styles.scss new file: docs/_resource/theme/main.html new file: docs/_static/percona-logo.jpg new file: docs/_static/percona-logo.svg new file: docs/_static/percona-server-logo.jpg new file: docs/_static/percona-xtradb.png new file: docs/_static/percona_favicon.ico new file: docs/css/details.css new file: docs/css/percona.css new file: docs/css/toctree.css new file: docs/css/version-select.css new file: docs/js/version-select.js new file: mkdocs-base.yml new file: mkdocs-pdf.yml new file: mkdocs-percona.yml new file: mkdocs.yml modified: requirements.txt
1 parent 156dd48 commit 2d403ec

21 files changed

+1010
-12
lines changed

‎docs/_resource/overrides/404.html

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{#-
2+
This file was automatically generated - do not edit
3+
-#}
4+
{% extends "main.html" %}
5+
{% block content %}
6+
<h1>404 - Not found</h1>
7+
<p>
8+
We can't find the page you are looking for. Try using the Search or <a href= "{{ config.extra.homepage | d(nav.homepage.url, true) | url }}"> return to homepage </a>. </p>
9+
{% endblock %}

‎docs/_resource/overrides/main.html

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
{#
2+
MkDocs template for Netlify builds to customize docs layout
3+
by adding marketing-requested elements
4+
#}
5+
6+
{# Import the theme's layout. #}
7+
{% extends "base.html" %}
8+
9+
{%- macro relbar2 () %}
10+
<div class="md-relbar2__inner md-grid">
11+
<div class="md-content">
12+
<article class="md-content__inner md-typeset" role="main">
13+
<h4>Contact Us </h4>
14+
<p>For free technical help, visit the Percona <a class="reference external" href="https://forums.percona.com/c/mysql-mariadb/percona-server-for-mysql-8-0/20" target="_blank">Community Forum</a>.<br>
15+
<p>To report bugs or submit feature requests, open a <a class="reference external" href="https://jira.percona.com/projects/PS/issues/" target="_blank">JIRA</a> ticket.<br>
16+
<p>For paid <a class="reference external" href="https://www.percona.com/services/support"> support </a> and <a class="reference external" href="https://www.percona.com/services/managed-services"> managed </a> or <a class="reference external" href="https://www.percona.com/services/consulting">consulting services </a>, contact <a class="reference external" href="https://www.percona.com/about-percona/contact" target="_blank">Percona Sales</a>.</p>
17+
</article>
18+
</div>
19+
</div>
20+
{%- endmacro %}
21+
22+
{% block content %}
23+
24+
<!-- Edit button -->
25+
{% if page.edit_url %}
26+
<a
27+
href="{{ page.edit_url }}"
28+
title="{{ lang.t('edit.link.title') }}"
29+
class="md-content__button md-icon"
30+
>
31+
{% include ".icons/material/pencil.svg" %}
32+
</a>
33+
{% endif %}
34+
35+
<!--
36+
Hack: check whether the content contains a h1 headline. If it
37+
doesn't, the page title (or respectively site name) is used
38+
as the main headline.
39+
-->
40+
{% if not "\x3ch1" in page.content %}
41+
<h1>{{ page.title | d(config.site_name, true)}}</h1>
42+
{% endif %}
43+
44+
<!-- Markdown content -->
45+
{{ page.content }}
46+
47+
{{ relbar2() }}
48+
49+
<!-- Last update of source file -->
50+
{% if page and page.meta %}
51+
{% if page.meta.git_revision_date_localized or
52+
page.meta.revision_date
53+
%}
54+
{% include "partials/source-file.html" %}
55+
{% endif %}
56+
{% endif %}
57+
{% endblock %}
58+
59+

‎docs/_resource/overrides/partials/header.html

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
{#-
2+
This file was automatically generated - do not edit
3+
-#}
4+
<header class="md-header" data-md-component="header">
5+
<nav class="md-header__inner md-grid" aria-label="{{ lang.t('header.title') }}">
6+
<a href="https://percona.com/software/documentation" class="md-header__button md-logo" aria-label="{{ config.site_name }}" data-md-component="logo">
7+
{% include "partials/logo.html" %}
8+
</a>
9+
<label class="md-header__button md-icon" for="__drawer">
10+
{% include ".icons/material/menu" ~ ".svg" %}
11+
</label>
12+
<div class="md-header__title" data-md-component="header-title">
13+
<div class="md-header__ellipsis">
14+
<div class="md-header__topic">
15+
<span class="md-ellipsis"><a href="https://www.percona.com/software/documentation">
16+
Percona Product Documentation
17+
</a></span>
18+
</div>
19+
<div class="md-header__topic" data-md-component="header-topic">
20+
<span class="md-ellipsis">
21+
{% if page and page.meta and page.meta.title %}
22+
{{ page.meta.title }}
23+
{% else %}
24+
{{ page.title }}
25+
{% endif %}
26+
</span>
27+
</div>
28+
</div>
29+
</div>
30+
{% if not config.theme.palette is mapping %}
31+
<form class="md-header__option" data-md-component="palette">
32+
{% for option in config.theme.palette %}
33+
{% set primary = option.primary | replace(" ", "-") | lower %}
34+
{% set accent = option.accent | replace(" ", "-") | lower %}
35+
<input class="md-option" data-md-color-media="{{ option.media }}" data-md-color-scheme="{{ option.scheme }}" data-md-color-primary="{{ primary }}" data-md-color-accent="{{ accent }}" type="radio" name="__palette" id="__palette_{{ loop.index }}">
36+
{% if option.toggle %}
37+
<label class="md-header__button md-icon" title="{{ option.toggle.name }}" for="__palette_{{ loop.index0 or loop.length }}" hidden>
38+
{% include ".icons/" ~ option.toggle.icon ~ ".svg" %}
39+
</label>
40+
{% endif %}
41+
{% endfor %}
42+
</form>
43+
{% endif %}
44+
{% if config.extra.alternate %}
45+
<div class="md-header__option">
46+
<div class="md-select">
47+
{% set icon = config.theme.icon.alternate or "material/translate" %}
48+
<button class="md-header__button md-icon">
49+
{% include ".icons/" ~ icon ~ ".svg" %}
50+
</button>
51+
<div class="md-select__inner">
52+
<ul class="md-select__list">
53+
{% for alt in config.extra.alternate %}
54+
<li class="md-select__item">
55+
<a href="{{ alt.link | url }}" hreflang="{{ alt.lang }}" class="md-select__link">
56+
{{ alt.name }}
57+
</a>
58+
</li>
59+
{% endfor %}
60+
</ul>
61+
</div>
62+
</div>
63+
</div>
64+
{% endif %}
65+
{% if "search" in config["plugins"] %}
66+
<label class="md-header__button md-icon" for="__search">
67+
{% include ".icons/material/magnify.svg" %}
68+
</label>
69+
{% include "partials/search.html" %}
70+
{% endif %}
71+
{% if config.repo_url %}
72+
<div class="md-header__source">
73+
{% include "partials/source.html" %}
74+
</div>
75+
{% endif %}
76+
</nav>
77+
</header>

‎docs/_resource/overrides/partials/nav.html

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
{#-
2+
This file was automatically generated - do not edit
3+
-#}
4+
{% set class = "md-nav md-nav--primary" %}
5+
{% if "navigation.tabs" in features %}
6+
{% set class = class ~ " md-nav--lifted" %}
7+
{% endif %}
8+
{% if "toc.integrate" in features %}
9+
{% set class = class ~ " md-nav--integrated" %}
10+
{% endif %}
11+
<nav class="{{ class }}" aria-label="{{ lang.t('nav.title') }}" data-md-level="0">
12+
<label class="md-nav__title" for="__drawer">
13+
<a href="{{ config.extra.homepage | d(nav.homepage.url, true) | url }}" title="{{ config.site_name | e }}" class="md-nav__button md-logo" aria-label="{{ config.site_name }}" data-md-component="logo">
14+
{% include "partials/logo.html" %}
15+
</a>
16+
{{ config.site_name }}
17+
</label>
18+
{% if config.repo_url %}
19+
<div class="md-nav__source">
20+
{% include "partials/source.html" %}
21+
</div>
22+
{% endif %}
23+
<ul class="md-nav__list" data-md-scrollfix>
24+
{% for nav_item in nav %}
25+
{% set path = "__nav_" ~ loop.index %}
26+
{% set level = 1 %}
27+
{% include "partials/nav-item.html" %}
28+
{% endfor %}
29+
<label class="md-nav__title" for="__drawer">
30+
<a href="https://learn.percona.com/download-percona-server-8-0-manual" onclick="_gaq.push(['b._trackEvent', 'Percona Server', 'Download', 'Download Manual Percona Server']);" class="md-nav__link md-nav__link--active">
31+
Download PDF
32+
</a>
33+
</label>
34+
</ul>
35+
</nav>
36+

‎docs/_resource/templates/styles.scss

+110
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
/* Style for PDF created by MkDocs with mkdocs-with-pdf plugin (https://pypi.org/project/mkdocs-with-pdf/) */
2+
@media print {
3+
html {
4+
font-size: 100%;
5+
font-family: "Noto Sans", sans-serif;
6+
}
7+
8+
body {
9+
font-family: "Noto Sans", sans-serif;
10+
color: slategrey;
11+
}
12+
13+
article {
14+
font-family: "Noto Sans", sans-serif;
15+
text-align: justify;
16+
}
17+
18+
pre,
19+
code,
20+
var,
21+
samp,
22+
kbd,
23+
tt {
24+
font-family: monospace;
25+
font-size: 110%;
26+
}
27+
28+
pre code,
29+
pre var,
30+
pre samp,
31+
pre kbd,
32+
pre tt {
33+
font-size: 110%;
34+
}
35+
}
36+
37+
@page {
38+
size: a4 portrait;
39+
margin: 25mm 20mm 25mm 20mm;
40+
counter-increment: page;
41+
white-space: pre;
42+
color: slategrey;
43+
44+
@top-right {
45+
content: string(chapter);
46+
}
47+
48+
@bottom-left {
49+
content: string(subtitle);
50+
}
51+
52+
@bottom-center {
53+
content: counter(page)' of 'counter(pages);
54+
}
55+
56+
@bottom-right {
57+
}
58+
}
59+
60+
@page :first {
61+
@top-right {
62+
content: '';
63+
}
64+
65+
@bottom-right {
66+
content: '';
67+
}
68+
69+
@bottom-left {
70+
content: '';
71+
}
72+
}
73+
74+
article {
75+
page-break-before: always;
76+
min-height: 100%;
77+
}
78+
79+
article {
80+
81+
h1,
82+
h2,
83+
h3 {
84+
border-bottom: 0px solid #fff;
85+
}
86+
87+
h1>.pdf-order,
88+
h2>.pdf-order,
89+
h3>.pdf-order {
90+
padding-left: 6px;
91+
padding-right: 0.8rem;
92+
}
93+
}
94+
95+
article h1,
96+
h2,
97+
h3 {
98+
border-bottom: 0px solid #fff;
99+
color: #e97e03;
100+
}
101+
102+
.admonition {
103+
font-size: 100%;
104+
}
105+
106+
.md-typeset .admonition.note,
107+
.md-typeset details.note {
108+
color: slategrey;
109+
border-color: #fff;
110+
}

0 commit comments

Comments
 (0)