From 129ccdda1759598031abf5b3443eefb3f972a337 Mon Sep 17 00:00:00 2001 From: Marcelo Trylesinski Date: Sat, 22 Feb 2025 08:37:06 -0300 Subject: [PATCH] Add sponsorship page (#2877) --- README.md | 6 ++---- docs/sponsorship.md | 1 + mkdocs.yml | 5 +++++ requirements.txt | 2 +- 4 files changed, 9 insertions(+), 5 deletions(-) create mode 100644 docs/sponsorship.md diff --git a/README.md b/README.md index eed580af..1185cc01 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ $ pip install uvicorn ## Example -```python title="example.py" +```python title="main.py" from starlette.applications import Starlette from starlette.responses import JSONResponse from starlette.routing import Route @@ -77,11 +77,9 @@ app = Starlette(debug=True, routes=routes) Then run the application using Uvicorn: ```shell -$ uvicorn example:app +$ uvicorn main:app ``` -For a more complete example, see [encode/starlette-example](https://github.com/encode/starlette-example). - ## Dependencies Starlette only requires `anyio`, and the following are optional: diff --git a/docs/sponsorship.md b/docs/sponsorship.md new file mode 100644 index 00000000..ad55585e --- /dev/null +++ b/docs/sponsorship.md @@ -0,0 +1 @@ +# Coming soon... diff --git a/mkdocs.yml b/mkdocs.yml index b1f32422..02aae146 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -53,14 +53,19 @@ nav: - Community: - Third Party Packages: "third-party-packages.md" - Contributing: "contributing.md" + - Sponsorship: "sponsorship.md" markdown_extensions: + - attr_list - admonition - pymdownx.highlight - pymdownx.superfences - pymdownx.details - pymdownx.tabbed: alternate_style: true + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg watch: - starlette diff --git a/requirements.txt b/requirements.txt index 579b5e72..27da6b15 100644 --- a/requirements.txt +++ b/requirements.txt @@ -16,7 +16,7 @@ trio==0.28.0 # Documentation black==25.1.0 mkdocs==1.6.1 -mkdocs-material==9.6.1 +mkdocs-material==9.6.5 mkdocstrings-python==1.13.0 # Packaging -- 2.47.2