diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 1243fe7d54..ca8c586514 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -28,7 +28,7 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - pip install mkdocs-material + pip install mkdocs-material mkdocs-git-revision-date-localized-plugin - name: mkdocs deploy run: | diff --git a/custom_theme/main.html b/custom_theme/main.html deleted file mode 100644 index cb4a6cd1a0..0000000000 --- a/custom_theme/main.html +++ /dev/null @@ -1,10 +0,0 @@ -{% extends "base.html" %} - -{% block footer %} -
- - {% if config.copyright %} -

{{ config.copyright }}

- {% endif %} -
-{% endblock %} \ No newline at end of file diff --git a/custom_theme/img/favicon.ico b/docs/custom_theme/img/favicon.ico similarity index 100% rename from custom_theme/img/favicon.ico rename to docs/custom_theme/img/favicon.ico diff --git a/docs/custom_theme/partials/footer.html b/docs/custom_theme/partials/footer.html new file mode 100644 index 0000000000..cf149bf9ad --- /dev/null +++ b/docs/custom_theme/partials/footer.html @@ -0,0 +1,98 @@ + + +{% import "partials/language.html" as lang with context %} + + + \ No newline at end of file diff --git a/docs/css/extra.css b/docs/stylesheets/extra.css similarity index 68% rename from docs/css/extra.css rename to docs/stylesheets/extra.css index b4a95f8af7..7ec46cb545 100644 --- a/docs/css/extra.css +++ b/docs/stylesheets/extra.css @@ -1,23 +1,12 @@ -/* https://stackoverflow.com/questions/23211695/modifying-content-width-of-the-sphinx-theme-read-the-docs - -and https://github.com/readthedocs/sphinx_rtd_theme/issues/295 - -*/ -.wy-nav-content { - max-width: none !important; +:root { + --md-primary-fg-color: #3d90ce; } - -/* and fix wrap bug per https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html */ -.wy-table-responsive table td { - /* !important prevents the common CSS stylesheets from overriding - this as on RTD they are loaded after this stylesheet */ - white-space: normal !important; +:root > * { + /* Footer */ + --md-footer-bg-color: #3d90ce; } -.wy-table-responsive { - overflow: visible !important; -} ul.video-list { diff --git a/mkdocs.yml b/mkdocs.yml index 4116ed961e..2f9906e742 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,4 @@ -site_name: Documentation for Lens IDE +site_name: Lens - The Kubernetes IDE Documentation site_description: Documentation for Lens IDE. The only system you’ll ever need to take control of your Kubernetes clusters. It's open source and free. Download it today! site_author: Mirantis, Inc. site_url: https://docs.k8slens.dev @@ -36,7 +36,35 @@ theme: name: 'material' highlightjs: true language: 'en' - custom_dir: custom_theme + custom_dir: docs/custom_theme + favicon: img/favicon.ico + logo: img/lens-logo-icon.svg + palette: + scheme: preference + features: + - navigation.instant extra_css: - - css/extra.css + - stylesheets/extra.css + +plugins: + - search + - git-revision-date-localized + +markdown_extensions: + - toc: + permalink: true + toc_depth: 0 + +extra: + generator: false + social: + - icon: fontawesome/brands/github + link: https://github.com/lensapp/lens + name: Lens on GitHub + - icon: fontawesome/brands/twitter + link: https://twitter.com/k8slens + name: Lens on Twitter + - icon: fontawesome/brands/slack + link: http://k8slens.slack.com/ + name: Lens on Slack \ No newline at end of file