From 4cb38a15a5274b1d0fdeb089cb35d95ced25ac8f Mon Sep 17 00:00:00 2001 From: wozeparrot Date: Mon, 27 May 2024 21:32:09 +0000 Subject: [PATCH] tweak docs style (#4745) --- docs/favicon.svg | 25 ++++++++++++++++++++++++ mkdocs.yml | 49 ++++++++++++++++++++++++++++++++++-------------- 2 files changed, 60 insertions(+), 14 deletions(-) create mode 100644 docs/favicon.svg diff --git a/docs/favicon.svg b/docs/favicon.svg new file mode 100644 index 0000000000..420a33e0f8 --- /dev/null +++ b/docs/favicon.svg @@ -0,0 +1,25 @@ + + + + diff --git a/mkdocs.yml b/mkdocs.yml index c79f9e1af9..8f3d7ef0c9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -3,17 +3,18 @@ site_name: tinygrad docs site_url: https://docs.tinygrad.org/ repo_url: https://github.com/tinygrad/tinygrad/ nav: -- Home: index.md -- Quickstart: quickstart.md -- MNIST Tutorial: mnist.md -- API: - - Tensor: tensor.md - - Function: function.md - - dtypes: dtypes.md - - nn (Neural Networks): nn.md -- Showcase: showcase.md -- Developer: developer.md -- Environment: env_vars.md +- Home: + - index.md + - Quickstart: quickstart.md + - Showcase: showcase.md + - MNIST Tutorial: mnist.md + - API Reference: + - Tensor: tensor.md + - Function: function.md + - dtypes: dtypes.md + - nn (Neural Networks): nn.md + - Environment Variables: env_vars.md + - Developer: developer.md #- tinygrad: reference/ #extra_css: @@ -51,7 +52,7 @@ markdown_extensions: theme: name: material logo: logo_tiny_dark.svg - favicon: logo_tiny_dark.svg + favicon: favicon.svg features: - announce.dismiss - content.action.edit @@ -62,16 +63,36 @@ theme: - navigation.footer - navigation.indexes - navigation.sections - - navigation.tabs - - navigation.tabs.sticky - navigation.top - search.highlight - search.suggest - toc.follow + - toc.integrate palette: scheme: slate primary: black accent: lime + palette: + - media: "(prefers-color-scheme)" + accent: lime + primary: black + toggle: + icon: material/brightness-auto + name: Switch to light mode + - media: "(prefers-color-scheme: light)" + scheme: default + accent: lime + primary: black + toggle: + icon: material/brightness-7 + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + accent: lime + primary: black + toggle: + icon: material/brightness-4 + name: Switch to system preference plugins: - search - mkdocstrings: