Skip to content

Conversation

Burhan-Q
Copy link
Contributor

Rationale

Splitting out changes introduced in #30 specifically for docs/getting_started/basic/virtualenv.md page.

Changes

  • Adds annotations to code fenced content
  • Adds tabbed content
  • Fixes spacing between $`$ and $,$
  • Adds code markers to package names in hyperlink text
  • Adds Warning admonition
  • Adds uv bullet and .venv setup steps
  • Adds document front-matter and keywords

Testing

  • Deployed locally with mkdocs to view changes
  • Ran pre-commit for formatting

Note

Errors throw from pre-commit hooks likely due to mkdocs-material formatting

markdownlint.........................................................................Failed
- hook id: markdownlint
- exit code: 1

docs/getting_started/basic/virtualenv.md:105 MD046/code-block-style Code block style 
    [Expected: indented; Actual: fenced]

markdownlint-fix.....................................................................Failed
- hook id: markdownlint-fix
- exit code: 1

Screenshots

Tabbed content screenshot

image

Code block annotation screenshot

Collapsed

image

Expanded

image

Addition of uv and Warning admonition

image

@thesteve0
Copy link
Contributor

thesteve0 commented Apr 29, 2025

Edited to fix the pre-commit errors so this is now in a new PR
#96

I messed up please stand b

@kevin-dimichel
Copy link
Contributor

@Burhan-Q - Thank you for the contributions! To save you the toil of rebasing and fixing the markdownlint violation, I submitted #99 that include these changes (with pre-commit passing).

I'm going to close this PR since we just merged #99.

Sorry for the inconvenience.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants