starlette/mkdocs.yml

site_name: Starlette
site_description: The little ASGI library that shines.

theme:
    name: 'material'

repo_name: encode/starlette
repo_url: https://github.com/encode/starlette
edit_uri: ""

nav:
    - 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'
    - GraphQL: 'graphql.md'
    - API Schemas: 'schemas.md'
    - Events: 'events.md'
    - Background Tasks: 'background.md'
    - Exceptions: 'exceptions.md'
    - Debug: 'debug.md'
    - Test Client: 'testclient.md'
    - Release Notes: 'release-notes.md'

markdown_extensions:
  - markdown.extensions.codehilite:
      guess_lang: false
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.`

			`theme:`
			`name: 'material'`

			`repo_name: encode/starlette`
			`repo_url: https://github.com/encode/starlette`
			`edit_uri: ""`

Add mkdocs 2018-08-28 15:25:32 +00:00			`nav:`
Initial conversion of README.md to mkdocs 2018-08-28 13:58:03 +00:00			`- Introduction: 'index.md'`
Minor changes to docs layout 2018-09-05 12:45:39 +00:00			`- Applications: 'applications.md'`
Initial conversion of README.md to mkdocs 2018-08-28 13:58:03 +00:00			`- Requests: 'requests.md'`
Version 0.3 (#57) * Renamings * Version 0.3.0 * Black formatting * Update docs for 0.3 2018-09-05 10:39:38 +00:00			`- Responses: 'responses.md'`
Initial conversion of README.md to mkdocs 2018-08-28 13:58:03 +00:00			`- WebSockets: 'websockets.md'`
			`- Routing: 'routing.md'`
Minor changes to docs layout 2018-09-05 12:45:39 +00:00			`- Endpoints: 'endpoints.md'`
Middleware (#82) * Tweaks to URL datastructure * Linting * Add Middleware 2018-10-05 11:04:11 +00:00			`- Middleware: 'middleware.md'`
Update docs 2018-08-29 10:17:09 +00:00			`- Static Files: 'staticfiles.md'`
Add support for name to mount points. (#184) * Support name on app.mount(...) * Add templating docs * Remove erronous commit * Linting 2018-11-06 16:57:57 +00:00			`- Templates: 'templates.md'`
Add OpenAPIResponse, API Schema docs, etc... (#171) 2018-11-01 12:52:03 +00:00			`- GraphQL: 'graphql.md'`
			`- API Schemas: 'schemas.md'`
Add support for `app.on_event("startup")` and `app.on_event("cleanup")`. (#98) * Push black linting into ./scripts/test Fix some annotations etc. * Skip black on 3.7 * Fix script * Blergh. Shell equality tests are weird * Attempt to fix equality check * Document 'allow_origin_regex' * Support app.on_event('startup') and app.on_event('cleanup') * Nicer decorator handling for on_event * Add documentation for app.on_event() 2018-10-09 14:47:51 +00:00			`- Events: 'events.md'`
Minor tweaks to background task docs 2018-10-02 10:47:49 +00:00			`- Background Tasks: 'background.md'`
Minor changes to docs layout 2018-09-05 12:45:39 +00:00			`- Exceptions: 'exceptions.md'`
			`- Debug: 'debug.md'`
Version 0.3 (#57) * Renamings * Version 0.3.0 * Black formatting * Update docs for 0.3 2018-09-05 10:39:38 +00:00			`- Test Client: 'testclient.md'`
Add release notes 2018-10-29 09:33:33 +00:00			`- Release Notes: 'release-notes.md'`
Initial conversion of README.md to mkdocs 2018-08-28 13:58:03 +00:00
			`markdown_extensions:`
			`- markdown.extensions.codehilite:`
			`guess_lang: false`