Skip to content

Commit 30ef8e9

Browse files
committed
πŸ“š Update and polish feature list
1 parent 9a96b79 commit 30ef8e9

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@ Template for Python packages based on [`copier`](https://copier.readthedocs.io/e
77
## Features
88

99
* πŸ“¦ **Package management**: Test, build, and deploy your package with [Hatch](https://hatch.pypa.io/) environments.
10-
* πŸ“š **Documentation**: Use [MyST](https://mystmd.org/) or [MkDocs](https://www.mkdocs.org/) to document your package.
10+
* πŸ“š **Documentation**: Document your package with [MyST](https://mystmd.org/) or [MkDocs](https://www.mkdocs.org/).
1111
* 🧹 **Pre-commit**: Format and lint your code with [Ruff](https://docs.astral.sh/ruff/).
1212
* βš™οΈ **GitHub Actions**:
13-
* Deploy your documentation on [GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site).
13+
* Deploy documentation to [GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site).
14+
* Run pre-commit checks on every pull request.
1415

1516
## Usage
1617

β€Ždocs/index.mdβ€Ž

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,11 @@ A `copier`-based template for Python packages.
55
## Features
66

77
* πŸ“¦ **Package management**: Test, build, and deploy your package with [Hatch](https://hatch.pypa.io/) environments.
8-
* πŸ“š **Documentation**: Use [MyST](https://mystmd.org/) or [MkDocs](https://www.mkdocs.org/) to document your package.
8+
* πŸ“š **Documentation**: Document your package with [MyST](https://mystmd.org/) or [MkDocs](https://www.mkdocs.org/).
99
* 🧹 **Pre-commit**: Format and lint your code with [Ruff](https://docs.astral.sh/ruff/).
1010
* βš™οΈ **GitHub Actions**:
11-
* Deploy your documentation on [GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site).
11+
* Deploy documentation to [GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site).
12+
* Run pre-commit checks on every pull request.
1213

1314
## Usage
1415

0 commit comments

Comments
Β (0)