Skip to content

Commit 0d3559c

Browse files
ofekofek
authored
add official logo and badge (#433)
add official logo
1 parent f1dccf0 commit 0d3559c

File tree

10 files changed

+144
-5
lines changed

10 files changed

+144
-5
lines changed

‎README.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
# Hatch
22

3+
<div align="center">
4+
5+
<img src="docs/assets/images/logo.svg" alt="Hatch logo" width="500" role="img">
6+
37
| | |
48
| --- | --- |
59
| CI/CD | [![CI - Test](https://github.com/pypa/hatch/actions/workflows/test.yml/badge.svg)](https://github.com/pypa/hatch/actions/workflows/test.yml) [![CD - Build Hatch](https://github.com/pypa/hatch/actions/workflows/build-hatch.yml/badge.svg)](https://github.com/pypa/hatch/actions/workflows/build-hatch.yml) [![CD - Build Hatchling](https://github.com/pypa/hatch/actions/workflows/build-hatchling.yml/badge.svg)](https://github.com/pypa/hatch/actions/workflows/build-hatchling.yml) |
610
| Docs | [![Docs - Release](https://github.com/pypa/hatch/actions/workflows/docs-release.yml/badge.svg)](https://github.com/pypa/hatch/actions/workflows/docs-release.yml) [![Docs - Dev](https://github.com/pypa/hatch/actions/workflows/docs-dev.yml/badge.svg)](https://github.com/pypa/hatch/actions/workflows/docs-dev.yml) |
711
| Package | [![PyPI - Version](https://img.shields.io/pypi/v/hatch.svg?logo=pypi&label=PyPI&logoColor=gold)](https://pypi.org/project/hatch/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/hatchling.svg?color=blue&label=Downloads&logo=pypi&logoColor=gold)](https://pypi.org/project/hatch/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/hatch.svg?logo=python&label=Python&logoColor=gold)](https://pypi.org/project/hatch/) |
8-
| Meta | [![code style - black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![types - Mypy](https://img.shields.io/badge/types-Mypy-blue.svg)](https://github.com/python/mypy) [![imports - isort](https://img.shields.io/badge/imports-isort-ef8336.svg)](https://github.com/pycqa/isort) [![License - MIT](https://img.shields.io/badge/license-MIT-9400d3.svg)](https://spdx.org/licenses/) [![GitHub Sponsors](https://img.shields.io/github/sponsors/ofek?logo=GitHub%20Sponsors&style=social)](https://github.com/sponsors/ofek) |
12+
| Meta | [![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch) [![code style - black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![types - Mypy](https://img.shields.io/badge/types-Mypy-blue.svg)](https://github.com/python/mypy) [![imports - isort](https://img.shields.io/badge/imports-isort-ef8336.svg)](https://github.com/pycqa/isort) [![License - MIT](https://img.shields.io/badge/license-MIT-9400d3.svg)](https://spdx.org/licenses/) [![GitHub Sponsors](https://img.shields.io/github/sponsors/ofek?logo=GitHub%20Sponsors&style=social)](https://github.com/sponsors/ofek) |
13+
14+
</div>
915

1016
-----
1117

‎docs/.overrides/partials/copyright.html‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<div class="md-copyright">
2+
{% if config.copyright %}
3+
<div class="md-copyright__highlight">
4+
{{ config.copyright }}
5+
</div>
6+
<div>
7+
Logo by
8+
<a
9+
href="https://openai.com/dall-e-2/"
10+
target="_blank" rel="noopener"
11+
>
12+
DALL·E
13+
</a>
14+
and
15+
<a
16+
href="https://boriscrowther.com/"
17+
target="_blank" rel="noopener"
18+
>
19+
Boris Crowther
20+
</a>
21+
</div>
22+
{% endif %}
23+
{% if not config.extra.generator == false %}
24+
Made with
25+
<a
26+
href="https://squidfunk.github.io/mkdocs-material/"
27+
target="_blank" rel="noopener"
28+
>
29+
Material for MkDocs
30+
</a>
31+
{% endif %}
32+
</div>

‎docs/assets/images/favicon.ico‎

-11.7 KB
Binary file not shown.

‎docs/assets/images/logo.png‎

-1.16 MB
Binary file not shown.

‎docs/assets/images/logo.svg‎

Lines changed: 76 additions & 0 deletions
Loading

‎docs/assets/images/logo.webp‎

-51.5 KB
Binary file not shown.

‎docs/index.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# Hatch
22

3+
![Hatch logo](assets/images/logo.svg){ align="left" width="300" role="img" }
4+
35
| | |
46
| --- | --- |
57
| CI/CD | [![CI - Test](https://github.com/pypa/hatch/actions/workflows/test.yml/badge.svg){ loading=lazy }](https://github.com/pypa/hatch/actions/workflows/test.yml) [![CD - Build Hatch](https://github.com/pypa/hatch/actions/workflows/build-hatch.yml/badge.svg){ loading=lazy }](https://github.com/pypa/hatch/actions/workflows/build-hatch.yml) [![CD - Build Hatchling](https://github.com/pypa/hatch/actions/workflows/build-hatchling.yml/badge.svg){ loading=lazy }](https://github.com/pypa/hatch/actions/workflows/build-hatchling.yml) |
68
| Docs | [![Docs - Release](https://github.com/pypa/hatch/actions/workflows/docs-release.yml/badge.svg){ loading=lazy }](https://github.com/pypa/hatch/actions/workflows/docs-release.yml) [![Docs - Dev](https://github.com/pypa/hatch/actions/workflows/docs-dev.yml/badge.svg){ loading=lazy }](https://github.com/pypa/hatch/actions/workflows/docs-dev.yml) |
79
| Package | [![PyPI - Version](https://img.shields.io/pypi/v/hatch.svg?logo=pypi&label=PyPI&logoColor=gold){ loading=lazy }](https://pypi.org/project/hatch/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/hatchling.svg?color=blue&label=Downloads&logo=pypi&logoColor=gold){ loading=lazy }](https://pypi.org/project/hatch/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/hatch.svg?logo=python&label=Python&logoColor=gold){ loading=lazy }](https://pypi.org/project/hatch/) |
8-
| Meta | [![code style - black](https://img.shields.io/badge/code%20style-black-000000.svg){ loading=lazy }](https://github.com/psf/black) [![types - Mypy](https://img.shields.io/badge/types-Mypy-blue.svg){ loading=lazy }](https://github.com/python/mypy) [![imports - isort](https://img.shields.io/badge/imports-isort-ef8336.svg){ loading=lazy }](https://github.com/pycqa/isort) [![License - MIT](https://img.shields.io/badge/license-MIT-9400d3.svg){ loading=lazy }](https://spdx.org/licenses/) [![GitHub Sponsors](https://img.shields.io/github/sponsors/ofek?logo=GitHub%20Sponsors&style=social){ loading=lazy }](https://github.com/sponsors/ofek) |
10+
| Meta | [![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg){ loading=lazy }](https://github.com/pypa/hatch) [![code style - black](https://img.shields.io/badge/code%20style-black-000000.svg){ loading=lazy }](https://github.com/psf/black) [![types - Mypy](https://img.shields.io/badge/types-Mypy-blue.svg){ loading=lazy }](https://github.com/python/mypy) [![imports - isort](https://img.shields.io/badge/imports-isort-ef8336.svg){ loading=lazy }](https://github.com/pycqa/isort) [![License - MIT](https://img.shields.io/badge/license-MIT-9400d3.svg){ loading=lazy }](https://spdx.org/licenses/) [![GitHub Sponsors](https://img.shields.io/github/sponsors/ofek?logo=GitHub%20Sponsors&style=social){ loading=lazy }](https://github.com/sponsors/ofek) |
911

1012
-----
1113

‎docs/meta/authors.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
## Contributors
1010

1111
- Amjith Ramanujam [:material-twitter:](https://twitter.com/amjithr)
12+
- Arnaud Crowther [:material-github:](https://github.com/areknow)
1213
- Chris Warrick [:material-twitter:](https://twitter.com/Kwpolska)
1314
- Lumír 'Frenzy' Balhar [:material-email:](mailto:[email protected]) [:material-twitter:](https://twitter.com/lumirbalhar)
1415
- Ofek Lev [:material-web:](https://ofek.dev) [:material-github:](https://github.com/ofek) [:material-twitter:](https://twitter.com/Ofekmeister)

‎docs/next-steps.md‎

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

33
-----
44

5+
## Learn more
6+
57
At this point you should have a basic understanding of how to use Hatch.
68

79
Now you may want to check out advanced configuration for [environments](config/environment/overview.md) or [builds](config/build.md), set up your [preferred shell](config/hatch.md#shell), or read more about Hatch's [CLI](cli/about.md).
810

911
After that, check out the [Hatch Showcase](https://github.com/ofek/hatch-showcase) project to see examples of what is possible.
1012

1113
Finally, if you see a need, feel free to write a [plugin](plugins/about.md) for extended functionality.
14+
15+
## Community
16+
17+
For any projects using Hatch, you may add its official badge somewhere prominent like the README.
18+
19+
[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)
20+
21+
=== "Markdown"
22+
23+
```md
24+
[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)
25+
```
26+
27+
=== "reStructuredText"
28+
29+
```rst
30+
.. image:: https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg
31+
:alt: Hatch project
32+
:target: https://github.com/pypa/hatch
33+
```

‎mkdocs.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ docs_dir: docs
1111
site_dir: site
1212
theme:
1313
name: material
14+
custom_dir: docs/.overrides
1415
language: en
15-
favicon: assets/images/favicon.ico
16+
favicon: assets/images/logo.svg
1617
icon:
1718
repo: fontawesome/brands/github-alt
18-
# best approximation of an egg hatching
19-
logo: material/egg-easter
19+
logo: material/egg
2020
font:
2121
text: Roboto
2222
code: Roboto Mono

0 commit comments

Comments
 (0)