Rooba
/
starlette
mirror of https://github.com/encode/starlette.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
starlette/mkdocs.yml

61 lines
1.6 KiB
YAML
Raw Normal View History

Initial conversion of README.md to mkdocs
2018-08-28 13:58:03 +00:00
site_name: Starlette
site_description: The little ASGI library that shines.
mkdocs: Set site_url (#1215)
2021-06-25 07:46:38 +00:00
site_url: https://www.starlette.io
Initial conversion of README.md to mkdocs
2018-08-28 13:58:03 +00:00
theme:
Fix docs syntax highlighting (#1136) * mkdocs: Use python-markdown-extensions syntax highlighter * mkdocs: Use 2-space indent consistently in config file
2021-02-07 19:06:30 +00:00
name: 'material'
Add FastAPI sponsorship (#1271)
2021-08-19 14:17:41 +00:00
custom_dir: docs/overrides
Add dark theme for the documentation (#1230) * mkdocs: expanded theme configuration to add alternative dark theme. The default theme will be determined by the users system theme by the `prefers-color-scheme` media query. Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
2021-09-18 11:08:29 +00:00
palette:
- scheme: 'default'
media: '(prefers-color-scheme: light)'
toggle:
icon: 'material/lightbulb'
name: "Switch to dark mode"
- scheme: 'slate'
media: '(prefers-color-scheme: dark)'
primary: 'blue'
toggle:
icon: 'material/lightbulb-outline'
name: 'Switch to light mode'
Add edit button on documentation pages Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
2022-10-07 15:25:42 +00:00
icon:
repo: fontawesome/brands/github
Add copy button on documentation (#2257)
2023-08-27 12:07:33 +00:00
features:
- content.code.copy
Initial conversion of README.md to mkdocs
2018-08-28 13:58:03 +00:00
repo_name: encode/starlette
repo_url: https://github.com/encode/starlette
Add edit button on documentation pages Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
2022-10-07 15:25:42 +00:00
edit_uri: edit/master/docs/
Initial conversion of README.md to mkdocs
2018-08-28 13:58:03 +00:00
Add mkdocs
2018-08-28 15:25:32 +00:00
nav:
Fix docs syntax highlighting (#1136) * mkdocs: Use python-markdown-extensions syntax highlighter * mkdocs: Use 2-space indent consistently in config file
2021-02-07 19:06:30 +00:00
- Introduction: 'index.md'
- Applications: 'applications.md'
- Requests: 'requests.md'
- Responses: 'responses.md'
- WebSockets: 'websockets.md'
- Routing: 'routing.md'
- Endpoints: 'endpoints.md'
- Middleware: 'middleware.md'
- Static Files: 'staticfiles.md'
- Templates: 'templates.md'
- Database: 'database.md'
- GraphQL: 'graphql.md'
- Authentication: 'authentication.md'
- API Schemas: 'schemas.md'
Replace reference from Events to Lifespan on the mkdocs.yml (#2072)
2023-03-09 23:20:06 +00:00
- Lifespan: 'lifespan.md'
Fix docs syntax highlighting (#1136) * mkdocs: Use python-markdown-extensions syntax highlighter * mkdocs: Use 2-space indent consistently in config file
2021-02-07 19:06:30 +00:00
- Background Tasks: 'background.md'
- Server Push: 'server-push.md'
- Exceptions: 'exceptions.md'
- Configuration: 'config.md'
- Test Client: 'testclient.md'
- Third Party Packages: 'third-party-packages.md'
Add contributing docs (#1686) * Add contributing docs * Add screenshots * Update docs/contributing.md Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com> Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
2022-06-18 16:34:13 +00:00
- Contributing: 'contributing.md'
Fix docs syntax highlighting (#1136) * mkdocs: Use python-markdown-extensions syntax highlighter * mkdocs: Use 2-space indent consistently in config file
2021-02-07 19:06:30 +00:00
- Release Notes: 'release-notes.md'
Initial conversion of README.md to mkdocs
2018-08-28 13:58:03 +00:00
markdown_extensions:
Version 0.13 (#704) * Version 0.13 * Fix misnamed requirement * Updating routing docs * Update routing docs * Update docs * Simpler Middleware signature * Update middleware docs * Update exception docs * Allow 'None' in middleware lists, for easy disabling of middleware. * Update README
2019-11-13 12:25:18 +00:00
- mkautodoc
Deprecate built-in GraphQL support (#1135) * Deprecate GraphQLApp * Add deprecation warning to pytest ignore list * Tweak deprecation warnings
2021-02-05 19:13:39 +00:00
- admonition
Fix docs syntax highlighting (#1136) * mkdocs: Use python-markdown-extensions syntax highlighter * mkdocs: Use 2-space indent consistently in config file
2021-02-07 19:06:30 +00:00
- pymdownx.highlight
- pymdownx.superfences
Improve wording and structure of pure ASGI middleware docs (#1723) * Improve wording and structure of pure ASGI middleware docs * Address feedback Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
2022-08-09 10:08:52 +00:00
- pymdownx.tabbed:
Replace reference from Events to Lifespan on the mkdocs.yml (#2072)
2023-03-09 23:20:06 +00:00
alternate_style: true