Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand Down
1 change: 1 addition & 0 deletions docs/sponsorship.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Coming soon...
5 changes: 5 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down