From ded730045506b8d501ea4c291f756089caa7ff0c Mon Sep 17 00:00:00 2001 From: Zanie Blue Date: Fri, 16 Aug 2024 18:09:21 -0500 Subject: [PATCH] Disable collapsible navigation in the documentation (#5674) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Removes the collapsible sections in favor of larger font navigation headings. I found the bold to be too distracting from the content itself — it might be okay in the future if the navigation bar is further left. Before: Screenshot 2024-08-16 at 6 03 57 PM After: Screenshot 2024-08-16 at 6 05 36 PM (No change to the mobile view) Screenshot 2024-08-16 at 6 05 03 PM Screenshot 2024-08-16 at 6 05 13 PM --- docs/getting-started/index.md | 14 ++++++++++++++ docs/reference/index.md | 11 +++++++++++ docs/stylesheets/extra.css | 20 ++++++++++++++++++++ mkdocs.template.yml | 4 +++- 4 files changed, 48 insertions(+), 1 deletion(-) create mode 100644 docs/getting-started/index.md create mode 100644 docs/reference/index.md diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md new file mode 100644 index 000000000..1c0e21668 --- /dev/null +++ b/docs/getting-started/index.md @@ -0,0 +1,14 @@ +# Getting started + +To help you get started with uv, we'll cover a few important topics: + +- [Installing uv](./installation.md) +- [First steps after installation](./first-steps.md) +- [An overview of uv's features](./features.md) +- [How to get help](./help.md) + +Read on, or jump ahead to another section: + +- Get going quickly with [guides](../guides/index.md) for common workflows. +- Learn more about the core [concepts](../concepts/index.md) in uv. +- Use the [reference](../reference/index.md) documentation to find details about something specific. diff --git a/docs/reference/index.md b/docs/reference/index.md new file mode 100644 index 000000000..4cd678b8f --- /dev/null +++ b/docs/reference/index.md @@ -0,0 +1,11 @@ +# Reference + +The reference section provides information about specific parts of uv: + +- [Commands](./cli.md): A reference for uv's command line interface. +- [Settings](./settings.md): A reference for uv's configuration schema. +- [Resolver](./resolver-internals.md): Details about the internals of uv's resolver. +- [Versioning](./versioning.md): uv's versioning policy. +- [Platform support](./platforms.md): uv's supported operating systems and architectures. + +Looking for a broader overview? Check out the [concepts](../concepts/index.md) documentation. diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index a356052b6..2796f83cd 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -126,10 +126,14 @@ See https://github.com/astral-sh/uv/issues/5130 */ } } + /* Reducing spacing between nav items to fit more content */ .md-nav__link { margin-top: 0.25em; } +.md-nav__item--section { + margin: 0.75em 0; +} /* Retain larger spacing for each top-level section in the nav */ .md-nav__item--nested { margin-top: 0.6em; @@ -143,6 +147,22 @@ See https://github.com/astral-sh/uv/issues/5130 */ user-select: none; } +/* Increase the size of the sections headings, remove the bold */ +.md-nav__item--section>.md-nav__link { + font-size: 16px; + font-weight: normal; +} +/* Increase the size of the index nav item to match the sections */ +.md-nav__item:first-child { + font-size: 16px; + font-weight: normal; +} +/* But do not increase the size of other nav items */ +.md-nav__item--section > .md-nav > .md-nav__list > .md-nav__item { + font-size: 14px; + font-weight: normal; +} + /* Bold the active nav link for accessibility */ .md-nav__link--active { font-weight: bold; diff --git a/mkdocs.template.yml b/mkdocs.template.yml index e3c25b471..e1430f6e5 100644 --- a/mkdocs.template.yml +++ b/mkdocs.template.yml @@ -7,7 +7,7 @@ theme: - navigation.instant - navigation.instant.prefetch - navigation.instant.progress - - navigation.expand + - navigation.sections - navigation.indexes - navigation.tracking - content.code.annotate @@ -82,6 +82,7 @@ extra: nav: - Introduction: index.md - Getting started: + - getting-started/index.md - Installation: getting-started/installation.md - First steps: getting-started/first-steps.md - Features: getting-started/features.md @@ -122,6 +123,7 @@ nav: - Locking environments: pip/compile.md - Compatibility with pip: pip/compatibility.md - Reference: + - reference/index.md - Commands: reference/cli.md - Settings: reference/settings.md - Resolver: reference/resolver-internals.md