docs: add Installation page (uv install path) - #60
Open
AllAboutDocs wants to merge 1 commit into
Open
AllAboutDocs wants to merge 1 commit into
AllAboutDocs wants to merge 1 commit into
Conversation
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new
docs/INSTALLATION.mdpage covering prerequisites, installinguv, and installing MkDocs 2.0's pre-release with it. Based on hands-on testing of the full install flow.What's included
uvvia the standalone installer, including thesource $HOME/.local/bin/envstep needed whenuvisn't recognized right after install.uv tool install mkdocs --prerelease allow, with an explicit note that this differs from pip's--preflag — passing--preto uv doesn't error, it silently installs the latest stable release instead (confirmed firsthand).uv python list→uv python install→ reinstalling with--pythonexplicitly.uv tool list, sincemkdocs --versionno longer exists in2.0.dev4.Intentionally not included yet
pippath from issue Installation docs... #57. Going with uv only for now per your answer there; can add a concise pip/venv section later if we still want both documented.Testing
Confirmed via
mkdocs servethat the page renders correctly at/installation/, and reproduced each command/flag behavior described here firsthand (starting from a stock macOS install with only Python 3.9.6 via Xcode CLT present, and uv installed fresh).