Skip to content

Commit a8b0260

Browse files
committed
πŸ“ docs: add some emojis and fix some rendering issues
1 parent 30bda1a commit a8b0260

10 files changed

Lines changed: 52 additions & 41 deletions

File tree

β€Ždocs/features/docker.mdβ€Ž

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ When `dockerfile: true` (the default), the template generates Docker configurati
1212

1313
## Commands
1414

15-
/// tab | make
15+
/// tab | :simple-make: make
1616

1717
```bash
1818
# Build Docker images
@@ -27,7 +27,7 @@ make docker-stop
2727

2828
///
2929

30-
/// tab | mise
30+
/// tab | :material-wrench: mise
3131

3232
```bash
3333
# Build Docker images

β€Ždocs/features/documentation.mdβ€Ž

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Generated projects include a fully configured [MkDocs](https://github.com/mkdocs
1111

1212
## Local Development
1313

14-
/// tab | make
14+
/// tab | :simple-make: make
1515

1616
```bash
1717
# Serve docs with live reload (localhost:8080)
@@ -23,7 +23,7 @@ make docs-check
2323

2424
///
2525

26-
/// tab | mise
26+
/// tab | :material-wrench: mise
2727

2828
```bash
2929
# Serve docs with live reload (localhost:8080)
@@ -37,7 +37,7 @@ mise run docs:check
3737

3838
## Deployment
3939

40-
/// tab | make
40+
/// tab | :simple-make: make
4141

4242
```bash
4343
# Deploy to GitHub Pages
@@ -46,7 +46,7 @@ make docs-deploy
4646

4747
///
4848

49-
/// tab | mise
49+
/// tab | :material-wrench: mise
5050

5151
```bash
5252
# Deploy to GitHub Pages

β€Ždocs/features/optional.mdβ€Ž

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Scaffolds a [Typer](https://typer.tiangolo.com/) CLI application with:
1010
- CLI module with a sample command
1111
- Customizable CLI name via the `cli_name` variable
1212

13-
/// tab | make
13+
/// tab | :simple-make: make
1414

1515
```bash
1616
# Install CLI globally after generation
@@ -19,7 +19,7 @@ make setup-cli
1919

2020
///
2121

22-
/// tab | mise
22+
/// tab | :material-wrench: mise
2323

2424
```bash
2525
# Install CLI globally after generation

β€Ždocs/features/quality-tools.mdβ€Ž

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The template sets up a comprehensive code quality pipeline that runs automatical
66

77
[Ruff](https://github.com/astral-sh/ruff) handles both **formatting** and **linting** in a single, fast tool.
88

9-
/// tab | make
9+
/// tab | :simple-make: make
1010

1111
```bash
1212
# Auto-format code
@@ -18,7 +18,7 @@ make check-quality
1818

1919
///
2020

21-
/// tab | mise
21+
/// tab | :material-wrench: mise
2222

2323
```bash
2424
# Auto-format code
@@ -36,15 +36,15 @@ Ruff is configured in `pyproject.toml` with sensible defaults. It replaces Black
3636

3737
[Mypy](https://github.com/python/mypy) performs static type checking.
3838

39-
/// tab | make
39+
/// tab | :simple-make: make
4040

4141
```bash
4242
make check-types
4343
```
4444

4545
///
4646

47-
/// tab | mise
47+
/// tab | :material-wrench: mise
4848

4949
```bash
5050
mise run check:types
@@ -74,7 +74,7 @@ pre-commit install
7474

7575
## Running All Checks
7676

77-
/// tab | make
77+
/// tab | :simple-make: make
7878

7979
```bash
8080
# Run everything: lint, types, docs build
@@ -83,7 +83,7 @@ make check-all
8383

8484
///
8585

86-
/// tab | mise
86+
/// tab | :material-wrench: mise
8787

8888
```bash
8989
# Run everything: lint, types, docs build

β€Ždocs/features/task-runner.mdβ€Ž

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,26 @@ Project tasks are defined in a [`mise.toml`](https://mise.jdx.dev/) file. A `Mak
44

55
Run any task with:
66

7+
/// tab | :simple-make: make
8+
79
```bash
810
make <task>
9-
# or directly:
11+
```
12+
13+
///
14+
15+
/// tab | :material-wrench: mise
16+
17+
```bash
1018
mise run <task>
1119
```
1220

13-
> [!TIP]
14-
> Prefer `mise run` over `make` when running tasks directly:
15-
>
16-
> - **Auto-completion**: Run `make mise-setup-completions` to install shell completions for mise, giving you tab-completion for all tasks.
17-
> - **Flags & arguments**: mise tasks can accept flags and positional arguments (e.g. `mise run docker-build --dev`, `mise run test -- -k test_foo`), which is not possible through `make`.
21+
///
22+
23+
!!! tip "Prefer `mise run` over `make` when running tasks directly"
24+
25+
- **Auto-completion**: Run `make mise-setup-completions` to install shell completions for mise, giving you tab-completion for all tasks.
26+
- **Flags & arguments**: mise tasks can accept flags and positional arguments (e.g. `mise run docker-build --dev`, `mise run test -- -k test_foo`), which is not possible through `make`.
1827

1928
## Available Tasks
2029

β€Ždocs/features/testing.mdβ€Ž

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ The template configures a full testing setup with pytest, coverage reporting, an
66

77
[pytest](https://github.com/pytest-dev/pytest) is the default test runner. Tests live in the `tests/` directory.
88

9-
/// tab | make
9+
/// tab | :simple-make: make
1010

1111
```bash
1212
make test
1313
```
1414

1515
///
1616

17-
/// tab | mise
17+
/// tab | :material-wrench: mise
1818

1919
```bash
2020
mise run test
@@ -26,15 +26,15 @@ mise run test
2626

2727
[Coverage.py](https://github.com/nedbat/coveragepy) generates test coverage reports in text, HTML, and XML formats.
2828

29-
/// tab | make
29+
/// tab | :simple-make: make
3030

3131
```bash
3232
make coverage
3333
```
3434

3535
///
3636

37-
/// tab | mise
37+
/// tab | :material-wrench: mise
3838

3939
```bash
4040
mise run coverage
@@ -48,15 +48,15 @@ The coverage threshold is configurable via the `coverage_threshold` template var
4848

4949
[Tox](https://github.com/tox-dev/tox) with [tox-uv](https://github.com/tox-dev/tox-uv) runs your test suite across multiple Python versions.
5050

51-
/// tab | make
51+
/// tab | :simple-make: make
5252

5353
```bash
5454
make tox
5555
```
5656

5757
///
5858

59-
/// tab | mise
59+
/// tab | :material-wrench: mise
6060

6161
```bash
6262
mise run tox
@@ -70,7 +70,7 @@ Tox is included by default but can be disabled by setting `tox: false` during pr
7070

7171
For parallel test execution, enable the `pytest_xdist` option during generation. This adds [pytest-xdist](https://github.com/pytest-dev/pytest-xdist) to your test dependencies.
7272

73-
/// tab | make
73+
/// tab | :simple-make: make
7474

7575
```bash
7676
# Tests automatically run in parallel when pytest-xdist is installed
@@ -79,7 +79,7 @@ make test
7979

8080
///
8181

82-
/// tab | mise
82+
/// tab | :material-wrench: mise
8383

8484
```bash
8585
# Tests automatically run in parallel when pytest-xdist is installed

β€Ždocs/getting-started/prerequisites.mdβ€Ž

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ Before using this template, make sure you have the following tools installed:
1515

1616
## Quick Install
1717

18-
/// tab | macOS (Homebrew)
18+
/// tab | :fontawesome-brands-apple: macOS (Homebrew)
1919
```bash
2020
brew install python uv mise pre-commit
2121
uv tool install copier --with copier-templates-extensions
2222
```
2323
///
2424

25-
/// tab | Linux
25+
/// tab | :fontawesome-brands-linux: Linux
2626
```bash
2727
# uv
2828
curl -LsSf https://astral.sh/uv/install.sh | sh
@@ -38,7 +38,7 @@ uv tool install copier --with copier-templates-extensions
3838
```
3939
///
4040

41-
/// tab | Windows
41+
/// tab | :fontawesome-brands-windows: Windows
4242
```powershell
4343
# uv
4444
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

β€Ždocs/getting-started/quickstart.mdβ€Ž

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Scaffold a New Project
44

5-
/// tab | Using uvx (no install needed)
5+
/// tab | :simple-uv: Using uvx (no install needed)
66

77
```bash
88
uvx --with copier-templates-extensions copier copy \
@@ -11,7 +11,7 @@ uvx --with copier-templates-extensions copier copy \
1111

1212
///
1313

14-
/// tab | Using installed Copier
14+
/// tab | :material-package: Using installed Copier
1515

1616
```bash
1717
# Install Copier globally (one-time)
@@ -24,13 +24,15 @@ copier copy --trust gh:bassemkaroui/python-template-uv project_name
2424
///
2525

2626
!!! note "Why `--trust`?"
27-
The template runs post-generation tasks (`git init`, `make setup-dev`, etc.) defined in `copier.yaml`, which requires the `--trust` flag.
27+
The template runs post-generation tasks (`git init`, `make setup-dev`, etc.) defined in `copier.yaml`, which requires the `--trust` flag.
2828

29-
!!! tip "Additional flags" - Add `--prereleases` to include pre-release template versions - Add `--vcs-ref=HEAD` to use the latest commit instead of the latest release
29+
!!! tip "Additional flags"
30+
- Add `--prereleases` to include pre-release template versions
31+
- Add `--vcs-ref=HEAD` to use the latest commit instead of the latest release
3032

3133
## Set Up Your Project
3234

33-
/// tab | make
35+
/// tab | :simple-make: make
3436

3537
```bash
3638
# Enter your project
@@ -46,7 +48,7 @@ make setup-cli
4648

4749
///
4850

49-
/// tab | mise
51+
/// tab | :material-wrench: mise
5052

5153
```bash
5254
# Enter your project
@@ -64,7 +66,7 @@ mise run setup:cli
6466

6567
## Verify Everything Works
6668

67-
/// tab | make
69+
/// tab | :simple-make: make
6870

6971
```bash
7072
# Run all checks: lint, types, docs build
@@ -73,7 +75,7 @@ make check-all
7375

7476
///
7577

76-
/// tab | mise
78+
/// tab | :material-wrench: mise
7779

7880
```bash
7981
# Run all checks: lint, types, docs build

β€Žmise.tomlβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ run = "uv run mkdocs build --strict ${usage_verbose:+--verbose}"
1010
description = "Serve the documentation locally (localhost:8080)"
1111
quiet = true
1212
usage = 'flag "--port <port>" default="8080"'
13-
run = "uv run mkdocs serve --dev-addr 127.0.0.1:${usage_port?}"
13+
run = "uv run mkdocs serve --dev-addr 127.0.0.1:${usage_port?} --livereload"
1414

1515
[tasks."docs:deploy"]
1616
description = "Deploy the documentation to GitHub Pages"

β€Žtemplate/mise.toml.jinjaβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ run = "uv run mkdocs build --strict ${usage_verbose:+--verbose}"
230230
description = "Serve the documentation locally (localhost:8080)"
231231
quiet = true
232232
usage = 'flag "--port <port>" default="8080"'
233-
run = "uv run mkdocs serve --dev-addr 127.0.0.1:${usage_port?}"
233+
run = "uv run mkdocs serve --dev-addr 127.0.0.1:${usage_port?} --livereload"
234234
{% if repository_provider == 'github' %}
235235
[tasks."docs:deploy"]
236236
description = "Deploy the documentation to GitHub Pages"

0 commit comments

Comments
Β (0)