Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 Update documentation dependencies and add dark mode #3109

Merged
merged 7 commits into from
Apr 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions docs/OWNERS

This file was deleted.

7 changes: 5 additions & 2 deletions docs/content/.pages
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
nav:
- Home: index.md
- ...
- Home:
- index.md
- CONTRIBUTING.md
- GOALS.md
- ...
2 changes: 1 addition & 1 deletion docs/content/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# <img src="logo.png" style="vertical-align: middle;" /> kcp Documentation
# kcp Documentation

## Overview

Expand Down
47 changes: 39 additions & 8 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
site_name: kcp Documentation
site_name: docs.kcp.io
repo_url: https://github.com/kcp-dev/kcp
site_url: https://docs.kcp.io/kcp/

Expand All @@ -15,18 +15,48 @@ theme:
features:
# Enable navigation section index pages, so we don't see Concepts > Concepts
- navigation.indexes
# Enable navigation tabs so we can group content by persona
- navigation.tabs
# Enable a copy button in code blocks
- content.code.copy
# Enable annotations on specific lines in code blocks
- content.code.annotate
logo: logo.png
logo: logo.svg
favicon: favicons/favicon.ico
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode

# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: white
toggle:
icon: material/brightness-7
name: Switch to dark mode

# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
toggle:
icon: material/brightness-4
name: Switch to system preference

extra:
version:
# Enable mike for multi-version selection
provider: mike

social:
- icon: fontawesome/brands/github
link: https://github.com/kcp-dev/kcp
- icon: fontawesome/brands/slack
link: https://kubernetes.slack.com/archives/C021U8WSAFK

plugins:
# https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin
# Greater control over how navigation links are shown
Expand All @@ -39,10 +69,15 @@ plugins:
module_name: 'main'
# Configure multiple language support
- i18n:
default_language: en
docs_structure: suffix
fallback_to_default: true
languages:
en:
- build: true
default: true
locale: en
name: English
reconfigure_material: true
reconfigure_search: true

markdown_extensions:
# Code block highlighting
Expand All @@ -58,10 +93,6 @@ markdown_extensions:
# Enable note/warning/etc. callouts
- admonition

# Our CSS
extra_css:
- stylesheets/kcp.css

# Live reload if any of these change when running 'mkdocs serve'
watch:
- mkdocs.yml
Expand Down
Binary file removed docs/overrides/favicons/android-144x144.png
Binary file not shown.
Binary file removed docs/overrides/favicons/android-192x192.png
Binary file not shown.
Binary file removed docs/overrides/favicons/android-36x36.png
Binary file not shown.
Binary file removed docs/overrides/favicons/android-48x48.png
Binary file not shown.
Binary file removed docs/overrides/favicons/android-72x72.png
Binary file not shown.
Binary file removed docs/overrides/favicons/android-96x96.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/overrides/favicons/apple-touch-icon-180x180.png
Binary file not shown.
Binary file added docs/overrides/favicons/apple-touch-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/overrides/favicons/favicon-1024.png
Binary file not shown.
Binary file modified docs/overrides/favicons/favicon-16x16.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/overrides/favicons/favicon-256.png
Binary file not shown.
Binary file modified docs/overrides/favicons/favicon-32x32.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/overrides/favicons/favicon.ico
Binary file not shown.
Binary file added docs/overrides/favicons/mstile-150x150.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/overrides/favicons/pwa-192x192.png
Binary file not shown.
Binary file removed docs/overrides/favicons/pwa-512x512.png
Binary file not shown.
Binary file removed docs/overrides/favicons/tile150x150.png
Binary file not shown.
Binary file removed docs/overrides/favicons/tile310x310.png
Binary file not shown.
Binary file removed docs/overrides/favicons/tile70x70.png
Binary file not shown.
Binary file removed docs/overrides/logo.png
Binary file not shown.
120 changes: 120 additions & 0 deletions docs/overrides/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions docs/overrides/partials/outdated.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{% extends "base.html" %}

{% block outdated %}
You're not viewing the latest version.
<a href="{{ '../' ~ base_url }}">
<strong>Click here to go to latest.</strong>
</a>
{% endblock %}
19 changes: 7 additions & 12 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,12 +1,7 @@
Jinja2==3.1.2
Markdown==3.3.7
MarkupSafe==2.1.2
mike==1.1.2
mkdocs==1.4.2
mkdocs-awesome-pages-plugin==2.8.0
mkdocs-macros-plugin==0.7.0
mkdocs-material==9.1.0
mkdocs-material-extensions==1.1.1
mkdocs-static-i18n==0.53
Pygments==2.14.0
pymdown-extensions==9.9.2
mike==2.0.0
mkdocs==1.5.3
mkdocs-awesome-pages-plugin==2.9.2
mkdocs-macros-plugin==1.0.5
mkdocs-material==9.5.17
mkdocs-material-extensions==1.3.1
mkdocs-static-i18n==1.2.2
Loading