README + docs enhancement

[icweaver]

Following up on #178 (comment)

• Fixes anchor links issue (links in GitHub readme are case-insensitive while links in Documenter.jl are not)
  • I opted to not just titlecase the links in the source README.md doc to keep things consistent with how GitHub automatically lowercases anchor links
• Enables syntax highlighting for julia-repl blocks

[github-actions]

Benchmark Results (Julia v1.10)

Time benchmarks

	main	ca6257b...	main / ca6257b...
Quantity/creation/Quantity(x)	3.41 ± 0.001 ns	3.42 ± 0.011 ns	0.997 ± 0.0032
Quantity/creation/Quantity(x, length=y)	3.11 ± 0.01 ns	3.11 ± 0.01 ns	1 ± 0.0046
Quantity/with_numbers/*real	3.1 ± 0.01 ns	3.11 ± 0.01 ns	0.997 ± 0.0045
Quantity/with_numbers/^int	8.05 ± 2.2 ns	8.05 ± 2.2 ns	1 ± 0.38
Quantity/with_numbers/^int * real	8.67 ± 2.5 ns	8.67 ± 2.5 ns	1 ± 0.4
Quantity/with_quantity/+y	4.04 ± 0.001 ns	4.04 ± 0.01 ns	1 ± 0.0025
Quantity/with_quantity//y	3.42 ± 0.011 ns	3.42 ± 0.011 ns	1 ± 0.0046
Quantity/with_self/dimension	3.1 ± 0.01 ns	3.11 ± 0.01 ns	0.997 ± 0.0045
Quantity/with_self/inv	3.11 ± 0.01 ns	3.11 ± 0.01 ns	1 ± 0.0046
Quantity/with_self/ustrip	2.79 ± 0.01 ns	2.79 ± 0.01 ns	0.997 ± 0.0051
QuantityArray/broadcasting/multi_array_of_quantities	0.144 ± 0.0029 ms	0.143 ± 0.0021 ms	1.01 ± 0.025
QuantityArray/broadcasting/multi_normal_array	0.0558 ± 0.0031 ms	0.0536 ± 0.0031 ms	1.04 ± 0.083
QuantityArray/broadcasting/multi_quantity_array	0.155 ± 0.0038 ms	0.155 ± 0.00086 ms	1 ± 0.025
QuantityArray/broadcasting/x^2_array_of_quantities	25.4 ± 2 μs	24.2 ± 1.7 μs	1.05 ± 0.11
QuantityArray/broadcasting/x^2_normal_array	5.28 ± 0.73 μs	5.35 ± 0.6 μs	0.987 ± 0.18
QuantityArray/broadcasting/x^2_quantity_array	6.96 ± 0.28 μs	6.96 ± 0.36 μs	1 ± 0.066
QuantityArray/broadcasting/x^4_array_of_quantities	0.0816 ± 0.0006 ms	0.0816 ± 0.0006 ms	1 ± 0.01
QuantityArray/broadcasting/x^4_normal_array	0.0498 ± 0.00019 ms	0.0498 ± 0.00021 ms	1 ± 0.0057
QuantityArray/broadcasting/x^4_quantity_array	0.053 ± 0.0029 ms	0.05 ± 0.00029 ms	1.06 ± 0.058
time_to_load	0.205 ± 0.0012 s	0.205 ± 0.00012 s	1 ± 0.0057

Memory benchmarks

	main	ca6257b...	main / ca6257b...
Quantity/creation/Quantity(x)	0 allocs: 0 B	0 allocs: 0 B
Quantity/creation/Quantity(x, length=y)	0 allocs: 0 B	0 allocs: 0 B
Quantity/with_numbers/*real	0 allocs: 0 B	0 allocs: 0 B
Quantity/with_numbers/^int	0 allocs: 0 B	0 allocs: 0 B
Quantity/with_numbers/^int * real	0 allocs: 0 B	0 allocs: 0 B
Quantity/with_quantity/+y	0 allocs: 0 B	0 allocs: 0 B
Quantity/with_quantity//y	0 allocs: 0 B	0 allocs: 0 B
Quantity/with_self/dimension	0 allocs: 0 B	0 allocs: 0 B
Quantity/with_self/inv	0 allocs: 0 B	0 allocs: 0 B
Quantity/with_self/ustrip	0 allocs: 0 B	0 allocs: 0 B
QuantityArray/broadcasting/multi_array_of_quantities	2 allocs: 0.382 MB	2 allocs: 0.382 MB	1
QuantityArray/broadcasting/multi_normal_array	2 allocs: 0.0763 MB	2 allocs: 0.0763 MB	1
QuantityArray/broadcasting/multi_quantity_array	2 allocs: 0.0763 MB	2 allocs: 0.0763 MB	1
QuantityArray/broadcasting/x^2_array_of_quantities	2 allocs: 0.382 MB	2 allocs: 0.382 MB	1
QuantityArray/broadcasting/x^2_normal_array	2 allocs: 0.0763 MB	2 allocs: 0.0763 MB	1
QuantityArray/broadcasting/x^2_quantity_array	2 allocs: 0.0763 MB	2 allocs: 0.0763 MB	1
QuantityArray/broadcasting/x^4_array_of_quantities	2 allocs: 0.382 MB	2 allocs: 0.382 MB	1
QuantityArray/broadcasting/x^4_normal_array	2 allocs: 0.0763 MB	2 allocs: 0.0763 MB	1
QuantityArray/broadcasting/x^4_quantity_array	2 allocs: 0.0763 MB	2 allocs: 0.0763 MB	1
time_to_load	0.153 k allocs: 14.5 kB	0.153 k allocs: 14.5 kB	1

[github-actions]

Benchmark Results (Julia v1)

Time benchmarks

	main	ca6257b...	main / ca6257b...
Quantity/creation/Quantity(x)	4.02 ± 0.01 ns	3.1 ± 0.01 ns	1.3 ± 0.0053
Quantity/creation/Quantity(x, length=y)	3.43 ± 0.011 ns	3.73 ± 0.001 ns	0.919 ± 0.003
Quantity/with_numbers/*real	3.1 ± 0.01 ns	2.79 ± 0.001 ns	1.11 ± 0.0036
Quantity/with_numbers/^int	8.67 ± 1.9 ns	8.67 ± 2.2 ns	1 ± 0.33
Quantity/with_numbers/^int * real	9.29 ± 2.2 ns	9.29 ± 2.2 ns	1 ± 0.33
Quantity/with_quantity/+y	4.35 ± 0.01 ns	4.35 ± 0.01 ns	1 ± 0.0033
Quantity/with_quantity//y	3.11 ± 0 ns	3.41 ± 0.01 ns	0.912 ± 0.0027
Quantity/with_self/dimension	3.11 ± 0.003 ns	3.11 ± 0.01 ns	1 ± 0.0034
Quantity/with_self/inv	3.11 ± 0.01 ns	3.12 ± 0.01 ns	0.997 ± 0.0045
Quantity/with_self/ustrip	2.79 ± 0.01 ns	4.02 ± 0.92 ns	0.696 ± 0.16
QuantityArray/broadcasting/multi_array_of_quantities	0.0905 ± 0.0008 ms	0.0904 ± 0.0054 ms	1 ± 0.06
QuantityArray/broadcasting/multi_normal_array	0.0528 ± 0.00022 ms	0.0498 ± 0.00026 ms	1.06 ± 0.0071
QuantityArray/broadcasting/multi_quantity_array	0.0622 ± 0.00025 ms	0.0623 ± 0.00021 ms	0.999 ± 0.0053
QuantityArray/broadcasting/x^2_array_of_quantities	13.5 ± 1.5 μs	13 ± 1.2 μs	1.04 ± 0.15
QuantityArray/broadcasting/x^2_normal_array	2.08 ± 0.99 μs	2.02 ± 1 μs	1.03 ± 0.72
QuantityArray/broadcasting/x^2_quantity_array	3.48 ± 0.091 μs	3.49 ± 0.11 μs	0.997 ± 0.041
QuantityArray/broadcasting/x^4_array_of_quantities	0.0845 ± 0.00062 ms	0.0842 ± 0.00063 ms	1 ± 0.011
QuantityArray/broadcasting/x^4_normal_array	0.0497 ± 0.00018 ms	0.0497 ± 0.00016 ms	1 ± 0.0049
QuantityArray/broadcasting/x^4_quantity_array	0.0529 ± 0.00019 ms	0.0468 ± 0.00017 ms	1.13 ± 0.0058
time_to_load	0.224 ± 0.00041 s	0.223 ± 0.00018 s	1 ± 0.002

Memory benchmarks

	main	ca6257b...	main / ca6257b...
Quantity/creation/Quantity(x)	0 allocs: 0 B	0 allocs: 0 B
Quantity/creation/Quantity(x, length=y)	0 allocs: 0 B	0 allocs: 0 B
Quantity/with_numbers/*real	0 allocs: 0 B	0 allocs: 0 B
Quantity/with_numbers/^int	0 allocs: 0 B	0 allocs: 0 B
Quantity/with_numbers/^int * real	0 allocs: 0 B	0 allocs: 0 B
Quantity/with_quantity/+y	0 allocs: 0 B	0 allocs: 0 B
Quantity/with_quantity//y	0 allocs: 0 B	0 allocs: 0 B
Quantity/with_self/dimension	0 allocs: 0 B	0 allocs: 0 B
Quantity/with_self/inv	0 allocs: 0 B	0 allocs: 0 B
Quantity/with_self/ustrip	0 allocs: 0 B	0 allocs: 0 B
QuantityArray/broadcasting/multi_array_of_quantities	3 allocs: 0.382 MB	3 allocs: 0.382 MB	1
QuantityArray/broadcasting/multi_normal_array	3 allocs: 0.0764 MB	3 allocs: 0.0764 MB	1
QuantityArray/broadcasting/multi_quantity_array	3 allocs: 0.0764 MB	3 allocs: 0.0764 MB	1
QuantityArray/broadcasting/x^2_array_of_quantities	3 allocs: 0.382 MB	3 allocs: 0.382 MB	1
QuantityArray/broadcasting/x^2_normal_array	3 allocs: 0.0764 MB	3 allocs: 0.0764 MB	1
QuantityArray/broadcasting/x^2_quantity_array	3 allocs: 0.0764 MB	3 allocs: 0.0764 MB	1
QuantityArray/broadcasting/x^4_array_of_quantities	3 allocs: 0.382 MB	3 allocs: 0.382 MB	1
QuantityArray/broadcasting/x^4_normal_array	3 allocs: 0.0764 MB	3 allocs: 0.0764 MB	1
QuantityArray/broadcasting/x^4_quantity_array	3 allocs: 0.0764 MB	3 allocs: 0.0764 MB	1
time_to_load	0.159 k allocs: 11.2 kB	0.159 k allocs: 11.2 kB	1

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.14%. Comparing base (3e2752f) to head (ca6257b).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #188   +/-   ##
=======================================
  Coverage   99.14%   99.14%           
=======================================
  Files          21       21           
  Lines        1292     1292           
=======================================
  Hits         1281     1281           
  Misses         11       11           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[MilesCranmer]

Thanks!