Zanie Blue
a6ecf463fc
Remove the last edited date from documentation pages ( #11753 )
...
I am bothered by the positioning of this immediately following the
content. I explored some other things, like forcing it the bottom of the
article, but in the end it was easiest to just hide it entirely
I think this belongs somewhere else, like in the footer — but I believe
that requires theme changes which are a bit more complicated than its
worth.
https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/howto/override-a-theme/
The main goal here was SEO metadata anyway.
Originally added in https://github.com/astral-sh/uv/pull/11164
Before
<img width="1334" alt="Screenshot 2025-02-24 at 12 57 56 PM"
src="https://github.com/user-attachments/assets/3f7423ff-fc18-40e8-be8a-f2e611af8221 "
/>
Now, it's omitted.
2025-02-24 13:27:00 -06:00
Zanie Blue
33446091d2
Improve the styling of collapsible nav items ( #10692 )
...
CI / integration test | uv publish (push) Blocked by required conditions
CI / check cache | ubuntu (push) Blocked by required conditions
CI / check cache | macos aarch64 (push) Blocked by required conditions
CI / check system | python on debian (push) Blocked by required conditions
CI / check system | python on fedora (push) Blocked by required conditions
CI / check system | python on ubuntu (push) Blocked by required conditions
CI / check system | python on opensuse (push) Blocked by required conditions
CI / check system | python on rocky linux 8 (push) Blocked by required conditions
CI / check system | python on rocky linux 9 (push) Blocked by required conditions
CI / check system | pypy on ubuntu (push) Blocked by required conditions
CI / check system | pyston (push) Blocked by required conditions
CI / check system | alpine (push) Blocked by required conditions
CI / check system | python on macos aarch64 (push) Blocked by required conditions
CI / check system | homebrew python on macos aarch64 (push) Blocked by required conditions
CI / check system | python on macos x86_64 (push) Blocked by required conditions
CI / check system | python3.10 on windows (push) Blocked by required conditions
CI / check system | python3.10 on windows x86 (push) Blocked by required conditions
CI / check system | python3.13 on windows (push) Blocked by required conditions
CI / check system | python3.12 via chocolatey (push) Blocked by required conditions
CI / check system | python3.9 via pyenv (push) Blocked by required conditions
CI / check system | python3.13 (push) Blocked by required conditions
CI / check system | conda3.11 on linux (push) Blocked by required conditions
CI / check system | conda3.8 on linux (push) Blocked by required conditions
CI / check system | conda3.11 on macos (push) Blocked by required conditions
CI / check system | conda3.8 on macos (push) Blocked by required conditions
CI / check system | conda3.11 on windows (push) Blocked by required conditions
CI / check system | conda3.8 on windows (push) Blocked by required conditions
CI / check system | amazonlinux (push) Blocked by required conditions
CI / check system | embedded python3.10 on windows (push) Blocked by required conditions
CI / benchmarks (push) Blocked by required conditions
I've been a bit unhappy with the collapsible project section. I think it
feels a little crowded and consequently hard to read. Here, we tweak the
styling to decrease the font size a little and increase the margins. I
aimed for a subtle change — we can change it more drastically later if
we want.
Before
<img width="1414" alt="Screenshot 2025-01-16 at 12 35 38 PM"
src="https://github.com/user-attachments/assets/820b87c6-2988-4170-87ae-cec9a0f3b4fb "
/>
After
<img width="1414" alt="Screenshot 2025-01-16 at 12 35 16 PM"
src="https://github.com/user-attachments/assets/0d0cdb6b-a6c6-4fe1-a7f2-48f6fd70d5bc "
/>
2025-01-16 15:02:43 -06:00
Zanie Blue
2ff705fba0
Add breadcrumbs to the documentation ( #9242 )
...
<img width="815" alt="Screenshot 2024-11-19 at 2 10 10 PM"
src="https://github.com/user-attachments/assets/49e645d2-1648-40b4-8bb4-ba5d6545a353 ">
<img width="815" alt="Screenshot 2024-11-19 at 2 10 25 PM"
src="https://github.com/user-attachments/assets/854d7bee-dc16-4429-ae11-789f50d1c6a4 ">
2024-11-19 22:31:43 -06:00
Zanie Blue
189cf6ead2
Use the full screen height for the main content to stabilize the nav ( #9153 )
...
On large screens, we require scrolling below the fold for the next page
/ prev page navigation footer. This dramatically improves visibility of
the left nav when looking at small pages like section overviews.
Critically, this stops the height of the navigation from jumping around
depending on the page you're on. On small screens, the positioning is
unchanged since the nav is in a hamburger menu and it'd be annoying to
scroll.
Eventually, we could move the next / prev nav out of the footer and into
the content, e.g., as in
https://github.com/astral-sh/uv/pull/9121#issuecomment-2479282706 .
These images don't quite do the change in experience justice. It's the
consistency when changing pages that feels the most different.
Before
<img width="1484" alt="Screenshot 2024-11-15 at 10 16 30 AM"
src="https://github.com/user-attachments/assets/e0729691-31ea-46cc-9679-636fb144eab7 ">
After
<img width="1474" alt="Screenshot 2024-11-15 at 10 15 26 AM"
src="https://github.com/user-attachments/assets/d01ae5cd-1347-45de-a294-fbd56b2d6fb5 ">
2024-11-19 19:53:25 +00:00
Zanie Blue
6930e033ff
Update styles to support collapsible nav ( #9095 )
...
In preparation for adding collapsible sections, cleans up the CSS
styling we apply to the nav.
The differences here are very subtle without collapsible sections
enabled. Note these screenshots show an increase in the secondary nav
font size (table of contents) which I subsequently fixed.
Before
<img width="1169" alt="Screenshot 2024-11-13 at 12 45 49 PM"
src="https://github.com/user-attachments/assets/10ea345f-73d3-430c-a6f0-8448e2471b60 ">
After
<img width="1169" alt="Screenshot 2024-11-13 at 12 45 29 PM"
src="https://github.com/user-attachments/assets/6c1af159-1684-4d00-b33d-c0a88b5e0aa9 ">
However, with collapsible sections you can see the bugs we're addressing
Before
<img width="1169" alt="Screenshot 2024-11-13 at 12 48 19 PM"
src="https://github.com/user-attachments/assets/7902791f-6c4d-4c84-b366-ba9c4bd96214 ">
After
<img width="1169" alt="Screenshot 2024-11-13 at 12 47 30 PM"
src="https://github.com/user-attachments/assets/6e0c4c7c-4a41-4dd5-a9f1-beabff965dbb ">
2024-11-15 17:00:23 -06:00
Zanie Blue
313612dad7
Fix table of contents sizing ( #7751 )
...
Now
<img width="864" alt="Screenshot 2024-09-27 at 10 57 40 PM"
src="https://github.com/user-attachments/assets/84c99d34-9b5a-4522-a2b4-0ef3c9cdda49 ">
Previously
<img width="864" alt="Screenshot 2024-09-27 at 10 57 46 PM"
src="https://github.com/user-attachments/assets/d7ff7401-ece5-4b49-813e-cd4e58d6cf19 ">
2024-09-27 22:59:38 -05:00
Charlie Marsh
8efd38c7a9
Use anchorlinks rather than permalinks ( #7626 )
...
## Summary
Unfortunately, the permalinks show up in the SERPs as part of the title:
Instead, we'll just make the headers themselves links.
Before:
After:
I prefer what we had before visually, but the SEO hit is bad enough that
I want to change it.
2024-09-22 19:35:45 -04:00
Zanie Blue
c8f27a3978
Increase the size of nav entries ( #6233 )
...
It's a common complaint that these are two small. I'm a bit on the fence
here, but we can make them bigger.
Before
<img width="1324" alt="Screenshot 2024-08-19 at 4 30 30 PM"
src="https://github.com/user-attachments/assets/a874b67a-cbd3-4e5c-a3f6-10a259f6b7dc ">
After
<img width="1324" alt="Screenshot 2024-08-19 at 4 30 24 PM"
src="https://github.com/user-attachments/assets/9f1f3559-07a1-4926-b6ab-fa3acc44045c ">
Before
<img width="602" alt="Screenshot 2024-08-19 at 4 30 59 PM"
src="https://github.com/user-attachments/assets/b9727b3a-cb33-41a5-8880-02b0c36025a2 ">
After
<img width="602" alt="Screenshot 2024-08-19 at 4 31 24 PM"
src="https://github.com/user-attachments/assets/edc2e66b-1e19-45fa-b658-1d0dc8b849bd ">
2024-08-20 11:22:29 -05:00
Zanie Blue
6dc05a3598
Attempt to fix nav in production documentation ( #6238 )
...
My deployment to production does not properly render the nav, as it does
locally, e.g.:
<img width="602" alt="Screenshot 2024-08-19 at 6 58 45 PM"
src="https://github.com/user-attachments/assets/32c93ad5-5a36-4843-a835-41431de962dc ">
2024-08-19 19:03:16 -05:00
Zanie Blue
ded7300455
Disable collapsible navigation in the documentation ( #5674 )
...
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:
<img width="1356" alt="Screenshot 2024-08-16 at 6 03 57 PM"
src="https://github.com/user-attachments/assets/75e49216-dc0d-4d26-a0d8-0283c29f9b81 ">
After:
<img width="1324" alt="Screenshot 2024-08-16 at 6 05 36 PM"
src="https://github.com/user-attachments/assets/cbce96ce-0969-46c5-80b6-e163481b8bfa ">
(No change to the mobile view)
<img width="823" alt="Screenshot 2024-08-16 at 6 05 03 PM"
src="https://github.com/user-attachments/assets/b450e413-d5a4-4d2d-9905-e8eb6ac6f546 ">
<img width="823" alt="Screenshot 2024-08-16 at 6 05 13 PM"
src="https://github.com/user-attachments/assets/bd251ea0-58d8-456e-bdc8-4e3699061e6c ">
2024-08-16 18:09:21 -05:00
Zanie Blue
f107406727
Generate CLI reference for documentation ( #5685 )
...
Loosely based on [Cargo's
format](https://github.com/rust-lang/cargo/blob/master/src/doc/src/commands/cargo-build.md )
<img width="896" alt="Screenshot 2024-08-01 at 9 44 03 AM"
src="https://github.com/user-attachments/assets/7c016bb3-2b54-46af-8ea8-ce82e07a0e30 ">
Future work includes:
- Grouping options
- Enforcing some sort of specific command ordering
- Showing possible values for enums
- Adding "long_about" to commands for more context
2024-08-01 16:04:16 +00:00
Zanie Blue
b0e37859ed
Bold active nav links for accessibility ( #5673 )
...
Before
<img width="412" alt="Screenshot 2024-07-31 at 3 47 38 PM"
src="https://github.com/user-attachments/assets/d95ebb62-079b-4e20-964c-9876b5978e4c ">
After
<img width="412" alt="Screenshot 2024-07-31 at 3 47 21 PM"
src="https://github.com/user-attachments/assets/a658d46a-3eeb-4f00-8952-d4c1dd91afe6 ">
2024-07-31 16:16:48 -05:00
Zanie Blue
0c680824ca
Omit the nav bar title when it has no use ( #5316 )
...
Turns out this is needed for navigation on mobile, but useless on larger
screens.
Closes #5130
<img width="1551" alt="Screenshot 2024-07-22 at 5 47 49 PM"
src="https://github.com/user-attachments/assets/2173549e-e65d-4691-be83-5e3bf0191dd5 ">
<img width="1551" alt="Screenshot 2024-07-22 at 5 48 02 PM"
src="https://github.com/user-attachments/assets/81012ba8-ce85-4276-8ffa-5c7ef556c389 ">
<img width="1551" alt="Screenshot 2024-07-22 at 5 48 08 PM"
src="https://github.com/user-attachments/assets/ecf8fcd7-e5d4-45c4-8d46-d09d91a8bbe9 ">
2024-07-31 10:08:22 -05:00
eth3lbert
89947681d1
Improve copy of console command examples ( #5397 )
...
## Summary
This PR improves the copy of the console command example by:
- Preventing the selection of generic prompts and generic output
- Lazily setting copy content by leveraging intersection observer
Most of the changes are inspired by
https://github.com/opensafely/documentation/pull/1461
Some other useful refs:
- https://github.com/squidfunk/mkdocs-material/issues/3647
-
https://mkdocstrings.github.io/recipes/#prevent-selection-of-prompts-and-output-in-python-code-blocks
Resolves #5355
## Test Plan
-
``` shell-session
mkdocs serve -f mkdocs.public.yml
```
- Navigate to http://localhost:8000/uv/first-steps/#viewing-the-version
- Try clicking the copy button
- Try copying by selecting the content
---------
Co-authored-by: Zanie Blue <contact@zanie.dev>
2024-07-31 14:52:02 +00:00
Zanie Blue
3822a43560
Fix blurring from nav title box shadow ( #5374 )
...
Fixes blur noted in https://github.com/astral-sh/uv/pull/5316 but
doesn't drop the title entirely.
https://github.com/astral-sh/uv/pull/5316 is my preferred design, if the
implementation was cost-free.
<img width="1259" alt="Screenshot 2024-07-23 at 3 53 48 PM"
src="https://github.com/user-attachments/assets/6f9b828b-884f-447d-8508-ba4023152e2f ">
(nothing to see at the rest of the breakpoints >1220)
<img width="1259" alt="Screenshot 2024-07-23 at 3 53 56 PM"
src="https://github.com/user-attachments/assets/b892cd76-cd91-4e78-b8c8-58e16a8b1130 ">
2024-07-23 17:33:57 -05:00
Zanie Blue
499b035c8e
Increase padding between each nav section ( #5373 )
...
<img width="1259" alt="Screenshot 2024-07-23 at 3 46 45 PM"
src="https://github.com/user-attachments/assets/dae4df4e-cea3-41a2-842c-652b4f9ca014 ">
<img width="1259" alt="Screenshot 2024-07-23 at 3 46 53 PM"
src="https://github.com/user-attachments/assets/b0751c4b-80bb-4344-816c-e23d5e45f0e4 ">
<img width="1259" alt="Screenshot 2024-07-23 at 3 46 57 PM"
src="https://github.com/user-attachments/assets/1cea6223-2757-49a0-9b87-1961f9bbd17b ">
<img width="1259" alt="Screenshot 2024-07-23 at 3 47 10 PM"
src="https://github.com/user-attachments/assets/a41061c6-f198-45ca-91b6-423f46375089 ">
2024-07-23 17:31:12 -05:00
Zanie Blue
49ea4a7a91
Reduce spacing between nav items ( #5310 )
...
**Before**
<img width="1475" alt="Screenshot 2024-07-22 at 3 56 46 PM"
src="https://github.com/user-attachments/assets/a9c6b929-0569-45a6-9840-d49d955dd55a ">
--------
**After**
<img width="1475" alt="Screenshot 2024-07-22 at 3 56 38 PM"
src="https://github.com/user-attachments/assets/98c85e03-fe62-4894-99f6-a49293eacf0b ">
2024-07-23 11:50:00 -05:00
Charlie Marsh
e61a221fef
Migrate from MdBook to MkDocs ( #5062 )
...
## Summary
We want to have consistency between the Ruff and uv documentation for
the upcoming release. We don't love the Ruff docs, but we'd rather have
consistency and then work towards improving them both, rather than have
two very-different documentation sites that both have weaknesses.
The setup here is simpler than in Ruff as: (1) we don't yet generate any
docs from Rust and (2) we don't try to reuse the README in the uv
documentation (which adds a lot of complexity in Ruff). So the change
here is mostly a 1-to-1 port to MkDocs.
## Test Plan
2024-07-15 22:22:07 +00:00
